Add important note about mkiocccentry execution

It is highly recommended that you run the tool from either the repo
directory itself (making sure you have the most up to date version of
course) or make sure you have installed it (also making sure you have
the most recent version). Not doing this will cause issues with checks
and in the case of out of date versions the submission would be rejected
due to violating rule 17. One can specify the options to mkiocccentry
for the tools required but if you forget or don't have the most up to
date version you will very likely run into problems.
This commit is contained in:
Cody Boone Ferguson committed 2025-02-06 10:13:53 -08:00
1 parent a2e216ec82
commit d2c6b42078
6 files changed
+67

No files matched your search

+12
View File
@@ -609,6 +609,18 @@ that if the directory exists already, you will have to remove it or move it
before this option will work a second time, just like in normal mode.
</p>
<p class="leftbar">
<strong>IMPORTANT NOTE</strong>: if you run the program outside the repo directory
(specifying the absolute or relative path to the tool) and you have not
installed the tools then you will have to specify the options for the tools that
are required like <code>chkentry(1)</code>, <code>txzchk(1)</code> and <code>fnamchk(1)</code>. But even if you
have installed them but some tools are out of date (in the install path) it will
cause problems. Additionally, if you do not have the most recent version when
submitting a tarball it will be rejected for not having the right versions of
the tools. This is why you <strong>MUST</strong> make sure you have the most recent
version of all the tools and you either run it from the repo directory itself OR
you install them (<code>make install</code> as via <code>sudo</code> or as root).
</p>
<p class="leftbar">
<a href="rules.html#rule17">Rule 17</a> has been <strong>significantly modified</strong>
to account for the new <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry repo</a> tools.
Thus, you are <strong>STRONGLY</strong> advised to use the <code>mkiocccentry(1)</code> tool