mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2720 from xexyl/faq-diff

Browse Source 
Split into two the FAQ about changes in entries
This commit is contained in:
Landon Curt Noll authored and GitHub committed 2024-10-23 11:39:35 -07:00
2 parents 45be4e0a0b 06d9cce70e
commit 46a5c63e69
4 files changed
+70 -16
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+20 -4
View File
@@ -481,7 +481,8 @@
</ul>
<h2 id="changes-made-to-ioccc-entries">8. <a href="#changes">Changes made to IOCCC entries</a></h2>
<ul>
<li><strong>Q 8.0</strong>: <a class="normal" href="#diff">How can I find out what was changed in an IOCCC entry source code?</a></li>
<li><strong>Q 8.0</strong>: <a class="normal" href="#diff">What was changed in some IOCCC entries?</a></li>
<li><strong>Q 8.0.1</strong>: <a class="normal" href="#detailed-diff">How can I see the extended details of what was changed?</a></li>
<li><strong>Q 8.1</strong>: <a class="normal" href="#fgets">Why were some calls to the libc function gets(3) changed to use fgets(3)?</a></li>
<li><strong>Q 8.2</strong>: <a class="normal" href="#consistency">Why do some remarks seem inconsistent with the entry?</a></li>
<li><strong>Q 8.3</strong>: <a class="normal" href="#orig_c">What is the meaning of the file ending in .orig.c in IOCCC entries?</a></li>
@@ -3957,9 +3958,19 @@ browser to <code>1984/index.html</code>, scroll down to <code>Winning Entries of
<p>Jump to: <a href="#">top</a></p>
<div id="what_changed">
<div id="diff">
<h3 id="q-8.0-how-can-i-find-out-what-was-changed-in-an-ioccc-entry-source-code">Q 8.0: How can I find out what was changed in an IOCCC entry source code?</h3>
<h3 id="q-8.0-what-was-changed-in-some-ioccc-entries">Q 8.0: What was changed in some IOCCC entries?</h3>
</div>
</div>
<p>When the website was being worked on in 2022-2024, the hint files were changed
to README.md, which are now used to construct index.html files, most text was
converted to markdown, typos were fixed, formatting fixes were made and most
entries that no longer worked were fixed to work or partly work.</p>
<p>If you wish to find out more, and see how to see the actual differences, check
the
FAQ on “<a href="#detailed-diff">how to find extended details of what was changed</a>”.</p>
<div id="detailed-diff">
<h3 id="q-8.0.1-how-can-i-see-the-extended-details-of-what-was-changed">Q 8.0.1: How can I see the extended details of what was changed?</h3>
</div>
<p>We have set up make rules to easily do see what was changed in the winning IOCCC
entry source. Using the <code>Makefile</code> in the entry directory, use
one of the following <code>make(1)</code> rules:</p>
@@ -4036,6 +4047,9 @@ include Makefile via the optional include directive line:</p>
<p>The <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1337.mk">1337.mk</a> file must exist in the current
directory, or under the directory above, or under the directory 2 levels
above in order for these rules to work.</p>
<p>If you’re an IOCCC masochist :-), or you really want even more details, very often the
<a href="thanks-for-help.html">thanks file</a> has much more details on what had to be
changed.</p>
<h4 id="tip-if-you-have-colordiff-installed-its-a-lot-easier-to-see-the-differences">Tip: if you have <code>colordiff</code> installed it’s a lot easier to see the differences</h4>
<p>To use these rules but provide a different <code>diff</code>, for instance <code>colordiff</code>,
just do:</p>
@@ -4044,7 +4058,7 @@ just do:</p>
<p>Obviously if you want to view the alternate code or the orig code you can just open
the files as described above.</p>
<p>See the
FAQ on “<a href="#original_source_code">original source code</a>”
FAQ on “<a href="#original_source_code">original source code files</a>”
for more information.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="gets">
@@ -4225,7 +4239,9 @@ the source code as it is now now, try:</p>
<pre><code> make diff_orig_prog</code></pre>
<p>See the
FAQ on “<a href="#what_changed">what changed</a>”
for more information and make rules relating to “<strong>original source file</strong>” differences.</p>
for more information on changes. If you want to see more details, including how
to see the actual differences, see the
FAQ on “<a href="#detailed-diff">what changed in more detail</a>”.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="renaming_files">
<h3 id="q-8.8-why-were-some-filenames-changed">Q 8.8: Why were some filenames changed?</h3>
faq.md
+25 -4
View File
@@ -87,7 +87,8 @@ This is FAQ version **28.1.2 2024-10-21**.
## 8. [Changes made to IOCCC entries](#changes)
- **Q 8.0**: <a class="normal" href="#diff">How can I find out what was changed in an IOCCC entry source code?</a>
- **Q 8.0**: <a class="normal" href="#diff">What was changed in some IOCCC entries?</a>
- **Q 8.0.1**: <a class="normal" href="#detailed-diff">How can I see the extended details of what was changed?</a>
- **Q 8.1**: <a class="normal" href="#fgets">Why were some calls to the libc function gets&lpar;3&rpar; changed to use fgets&lpar;3&rpar;?</a>
- **Q 8.2**: <a class="normal" href="#consistency">Why do some remarks seem inconsistent with the entry?</a>
- **Q 8.3**: <a class="normal" href="#orig_c">What is the meaning of the file ending in .orig.c in IOCCC entries?</a>
@@ -4822,10 +4823,23 @@ Jump to: [top](#)
<div id="what_changed">
<div id="diff">
### Q 8.0: How can I find out what was changed in an IOCCC entry source code?
### Q 8.0: What was changed in some IOCCC entries?
</div>
</div>
When the website was being worked on in 2022-2024, the hint files were changed
to README.md, which are now used to construct index.html files, most text was
converted to markdown, typos were fixed, formatting fixes were made and most
entries that no longer worked were fixed to work or partly work.
If you wish to find out more, and see how to see the actual differences, check
the
FAQ on "[how to find extended details of what was changed](#detailed-diff)".
<div id="detailed-diff">
### Q 8.0.1: How can I see the extended details of what was changed?
</div>
We have set up make rules to easily do see what was changed in the winning IOCCC
entry source. Using the `Makefile` in the entry directory, use
one of the following `make(1)` rules:
@@ -4852,6 +4866,7 @@ The following `make` rules exist to make a difference:
- This rule will show the diff of the entry to the original code (that is
`entry.c` to `entry.orig.c`).
For instance one of Landon's all time favourite entries is
[1984/mullender](1984/mullender/index.html) so the file names would be:
`mullender.orig.c`, `mullender.alt.c` and `mullender.c`. For later years, it
@@ -4917,6 +4932,10 @@ The [1337.mk](%%REPO_URL%%/1337.mk) file must exist in the current
directory, or under the directory above, or under the directory 2 levels
above in order for these rules to work.
If you're an IOCCC masochist :-), or you really want even more details, very often the
[thanks file](thanks-for-help.html) has much more details on what had to be
changed.
#### Tip: if you have `colordiff` installed it's a lot easier to see the differences
@@ -4932,7 +4951,7 @@ Obviously if you want to view the alternate code or the orig code you can just o
the files as described above.
See the
FAQ on "[original source code](#original_source_code)"
FAQ on "[original source code files](#original_source_code)"
for more information.
Jump to: [top](#)
@@ -5176,7 +5195,9 @@ the source code as it is now now, try:
See the
FAQ on "[what changed](#what_changed)"
for more information and make rules relating to "**original source file**" differences.
for more information on changes. If you want to see more details, including how
to see the actual differences, see the
FAQ on "[what changed in more detail](#detailed-diff)".
Jump to: [top](#)
thanks-for-help.html
+11 -4
View File
@@ -409,6 +409,7 @@ on an IOCCC entry by entry basis.</p>
<li><a href="#makefiles_fixes_improvements">Makefiles fixes and improvements</a></li>
<li><a href="#consistency_improvements">Consistency improvements</a></li>
<li><a href="#manifest_improvements">Manifest improvements</a></li>
<li><a href="#faq_improvements">FAQ improvements</a></li>
<li><a href="#thank_you_honor_roll">Thank you honor roll</a></li>
<li><a href="#neglect">Did we neglect to credit you?</a></li>
</ul>
@@ -4743,6 +4744,11 @@ manually.</p>
<p><a href="#cody">Cody</a> greatly improved the manifest of the winning entries so that the
links to the files in the index.html files make sense and are consistent,
although some might not make as much sense unless one looks into the entry.</p>
<div id="faq_improvements">
<h2 id="faq-improvements">FAQ improvements</h2>
</div>
<p><a href="#cody">Cody</a> greatly extended the FAQ to include much more information and he
helped reorganise it as well, from the new <code>faq.md</code> file.</p>
<div id="thank_you_honor_roll">
<h2 id="thank-you-honor-roll">Thank you honor roll</h2>
</div>
@@ -4792,10 +4798,11 @@ Wayback Machine</a> replace bad, broken, or otherwise
invalid links are thanks to Cody’s efforts! Another tool he wrote detected
inconsistent award titles in the <code>README.md</code> files (used to generate the
<code>index.html</code> files) and the CSV file that he generated from our SQL file.</p>
<p>Additionally Cody greatly improved the manifest of the winning entries and
checked that the generated html files, <code>index.html</code> and otherwise, look well and
are presentable, and he also suggested some CSS rules for image responsiveness on smaller
screens, as well as some other improvements.</p>
<p>Cody also greatly improved the manifests and checked that the generated html
files look well and are presentable, and he also suggested some CSS rules for
image responsiveness on smaller screens, as well as some other improvements.</p>
<p>Cody also wrote some of the <a href="bin/index.html">website scripts</a> and improved and
bug fixed others.</p>
<p><strong>THANK YOU VERY MUCH</strong> for your extensive efforts in helping improve the IOCCC
presentation of past IOCCC entries and fixing almost all past entries for modern
systems!</p>
thanks-for-help.md
+14 -4
View File
@@ -25,6 +25,7 @@ on an IOCCC entry by entry basis.
- [Makefiles fixes and improvements](#makefiles_fixes_improvements)
- [Consistency improvements](#consistency_improvements)
- [Manifest improvements](#manifest_improvements)
- [FAQ improvements](#faq_improvements)
- [Thank you honor roll](#thank_you_honor_roll)
- [Did we neglect to credit you?](#neglect)
@@ -6171,6 +6172,13 @@ manually.
links to the files in the index.html files make sense and are consistent,
although some might not make as much sense unless one looks into the entry.
<div id="faq_improvements">
## FAQ improvements
</div>
[Cody](#cody) greatly extended the FAQ to include much more information and he
helped reorganise it as well, from the new `faq.md` file.
<div id="thank_you_honor_roll">
## Thank you honor roll
@@ -6233,10 +6241,12 @@ invalid links are thanks to Cody's efforts! Another tool he wrote detected
inconsistent award titles in the `README.md` files (used to generate the
`index.html` files) and the CSV file that he generated from our SQL file.
Additionally Cody greatly improved the manifest of the winning entries and
checked that the generated html files, `index.html` and otherwise, look well and
are presentable, and he also suggested some CSS rules for image responsiveness on smaller
screens, as well as some other improvements.
Cody also greatly improved the manifests and checked that the generated html
files look well and are presentable, and he also suggested some CSS rules for
image responsiveness on smaller screens, as well as some other improvements.
Cody also wrote some of the [website scripts](bin/index.html) and improved and
bug fixed others.
**THANK YOU VERY MUCH** for your extensive efforts in helping improve the IOCCC
presentation of past IOCCC entries and fixing almost all past entries for modern