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

update FAQs with references to full requests

Browse Source
This commit is contained in:
Landon Curt Noll committed 2024-03-11 09:23:38 -07:00
1 parent ed822ba74b
commit 1f2920d7ba
2 files changed
+91 -23
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+40 -10
View File
@@ -1037,8 +1037,10 @@ dealing with a problematic entry. In a few fun cases, the IOCCC does not
compile by design!</p>
<p>If you have a fix that makes a minimal impact to the entry, then
please consider submitting that change in the form of a pull request.
Please see FAQ 5.2 <a href="#fix_an_entry">“How may I submit a fix to an
IOCCC entry”</a> for details.</p>
Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an
IOCCC entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does
someone make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<p>In some cases alternative code has been added that does compile on
some or most systems. Check the write up for the entry for “alt” code
and possible ways to compile and run that code. In some cases we
@@ -1073,9 +1075,11 @@ problematic entry in question to see if the problem is known, and if a
fix is wanted, consider trying to port the code to a 64-bit system and
submitting a pull request with that change. Pull requests that fix such
code while trying to minimize the impact of any changes and preserving
the spirit of the original code are very welcome! Please see FAQ 5.2
<a href="#fix_an_entry">“How may I submit a fix to an IOCCC entry”</a>
for details.</p>
the spirit of the original code are very welcome! Please see <a
href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a> for details. See also the <a href="#ull_request">FAQ 6.10 How
does someone make a change to a file and submit that change as a GitHub
pull request</a> for more information about pull requests.</p>
<h3
id="faq-3.3-why-do-some-ioccc-entries-fail-to-compile-under-macos"><a name="faq3_3"></a>FAQ
3.3: Why do some IOCCC entries fail to compile under macOS?</h3>
@@ -1111,8 +1115,10 @@ remembering to do it.</p>
If you have a change that fixes the problem (even if it just a change to
the <code>Makefile</code>) that doesn’t negatively impact the entry too
much, consider submitting that change in the form of a pull request.
Please see FAQ 5.2 <a href="#fix_an_entry">“How may I submit a fix to an
IOCCC entry”</a> for details.</p>
Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an
IOCCC entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does
someone make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<h3
id="faq-3.5-what-is-this-cb-tool-that-is-mentioned-in-the-ioccc"><a name="faq3_5"></a>FAQ
3.5: What is this cb tool that is mentioned in the IOCCC?</h3>
@@ -1364,6 +1370,9 @@ might be extra SDL packages required</h4>
installed it might be that you need additional SDL libraries. See the
entry’s index.html for details. If something is not noted you’re welcome
to report it as an issue or fix it and make a new pull request.</p>
<p>See the <a href="#ull_request">FAQ 6.10 How does someone make a
change to a file and submit that change as a GitHub pull request</a> for
more information about pull requests.</p>
<h3
id="faq-3.9-how-do-i-compile-an-ioccc-entry-that-requires-ncurses"><a name="faq3_9"></a><a name="curses"></a>FAQ
3.9: How do I compile an IOCCC entry that requires (n)curses?</h3>
@@ -2027,8 +2036,11 @@ happy to credit you in the <a href="thanks-for-help.html">thanks</a>
file. If you’re a previous author of a winning IOCCC entry we will
happily link to your entries; if you’re not we can link to your website
if you wish.</p>
<p>See <a href="#fix_an_entry">FAQ 5.2</a> for information on how to
submit a fix to an IOCCC entry.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to
an IOCCC entry</a> for information on how to submit a fix to an IOCCC
entry. See also the <a href="#ull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<h3
id="faq-5.2-how-may-i-submit-a-fix-to-an-ioccc-entry"><a name="faq5_2"></a><a name="fix_an_entry"></a>FAQ
5.2: How may I submit a fix to an IOCCC entry?</h3>
@@ -2067,6 +2079,10 @@ against the master <a
href="https://github.com/ioccc-src/winner/branches">branch</a> of the <a
href="https://github.com/ioccc-src/winner">ioccc-src/winner
repo</a>.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to
an IOCCC entry</a>. See also the <a href="#ull_request">FAQ 6.10 How
does someone make a change to a file and submit that change as a GitHub
pull request</a> for more information about pull requests.</p>
<p>Note that we’re much more inclined to accept an author’s fixes but
the judges have the final say in the matter.</p>
<h3
@@ -2103,6 +2119,10 @@ against the master <a
href="https://github.com/ioccc-src/winner/branches">branch</a> of the <a
href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a> to
submit a fix.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to
an IOCCC entry</a>. See also the <a href="#ull_request">FAQ 6.10 How
does someone make a change to a file and submit that change as a GitHub
pull request</a> for more information about pull requests.</p>
<h4 id="some-html-files-should-not-be-directly-modified">Some HTML files
should NOT be directly modified</h4>
<p>Nearly all HTML files on the <a href="https://www.ioccc.org">IOCCC
@@ -2127,6 +2147,10 @@ href="contact.html">contact.html</a>, one may read:</p>
&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;</code></pre>
<p>This means that you could consider editing the referenced markdown
file in your <a href="#pull_request">IOCCC pull request</a>.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to
an IOCCC entry</a>. See also the <a href="#ull_request">FAQ 6.10 How
does someone make a change to a file and submit that change as a GitHub
pull request</a> for more information about pull requests.</p>
<p>In some cases, the HTML file is <strong>NOT</strong> based on
markdown content, but instead came from JSON and other data files. So
instead of the above reference to a markdown file, you will read:</p>
@@ -2164,6 +2188,10 @@ against the master <a
href="https://github.com/ioccc-src/winner/branches">branch</a> of the <a
href="https://github.com/ioccc-src/winner">ioccc-src/winner
repo</a>.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to
an IOCCC entry</a>. See also the <a href="#ull_request">FAQ 6.10 How
does someone make a change to a file and submit that change as a GitHub
pull request</a> for more information about pull requests.</p>
<h2
id="faq-5.6-what-should-i-do-if-i-find-a-broken-or-wrong-web-link"><a name="faq5_6"></a><a name="fix_link"></a>FAQ
5.6: What should I do if I find a broken or wrong web link?</h2>
@@ -2173,7 +2201,9 @@ original intent) web link. If wish to fix such links, you may open a
GitHub pull request as described in <a href="#fix_web_site">FAQ 5.4</a>.
In the case of dead links or invalid links it doesn’t matter if it’s a
specific winner or not; the procedure is the same: open a pull request
to fix the problem.</p>
to fix the problem. See also the <a href="#ull_request">FAQ 6.10 How
does someone make a change to a file and submit that change as a GitHub
pull request</a> for more information about pull requests.</p>
<p>As far as how to find the updated link you can try using the <a
href="https://web.archive.org">Internet Wayback Machine</a> and see if
you can find the last non 4xx non 3xx page. Note, however, that just
faq.md
+51 -13
View File
@@ -934,8 +934,12 @@ hints, especially in cases were something else needs to be installed.
Please see the [bugs.html](bugs.html) file for details about known problems with IOCCC entries. In some cases you may be dealing with a problematic entry. In a few fun cases, the IOCCC does not compile by design!
If you have a fix that makes a minimal impact to the entry, then please consider submitting that change in the form of a pull request. Please
see FAQ 5.2 <a href="#fix_an_entry">"How may I submit a fix to an IOCCC entry"</a> for details.
If you have a fix that makes a minimal impact to the entry, then
please consider submitting that change in the form of a pull request.
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry). See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
In some cases alternative code has been added that does compile on some or most systems. Check the write up for the entry for "alt" code and possible ways to compile and run that code. In some cases we replaced the original code (but not the `.orig.c` file!) with code
that works for modern systems but one can view the original code in the
@@ -963,13 +967,16 @@ entries should be an alternate version.
Other entries like [2001/herrmann2](thanks-for-help.html#2001_herrmann2)
now work with 32-bit AND 64-bit systems.
Please see the [bugs.html](bugs.html) file for the problematic entry in question
to see if the problem is known, and if a fix is wanted, consider trying to port
the code to a 64-bit system and submitting a pull request with that change.
Pull requests that fix such code while trying to minimize the impact of any
changes and preserving the spirit of the original code are very welcome!
Please see FAQ 5.2 <a href="#fix_an_entry">"How may I submit a fix to an IOCCC
entry"</a> for details.
Please see the [bugs.html](bugs.html) file for the problematic entry
in question to see if the problem is known, and if a fix is wanted,
consider trying to port the code to a 64-bit system and submitting
a pull request with that change. Pull requests that fix such code
while trying to minimize the impact of any changes and preserving
the spirit of the original code are very welcome! Please see [FAQ
5.2 How may I submit a fix to an IOCCC entry](#fix_an_entry) for
details. See also the [FAQ 6.10 How does someone make a change to
a file and submit that change as a GitHub pull request](#ull_request)
for more information about pull requests.
### <a name="faq3_3"></a>FAQ 3.3: Why do some IOCCC entries fail to compile under macOS?
@@ -1008,8 +1015,10 @@ other things that have to be done plus remembering to do it.
See if the problem is mentioned in [bugs.html](bugs.html). If you have a change
that fixes the problem (even if it just a change to the `Makefile`) that doesn't
negatively impact the entry too much, consider submitting that change in the
form of a pull request. Please see FAQ 5.2 <a href="#fix_an_entry">"How may I
submit a fix to an IOCCC entry"</a> for details.
form of a pull request. Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry). See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
### <a name="faq3_5"></a>FAQ 3.5: What is this cb tool that is mentioned in the IOCCC?
@@ -1329,6 +1338,9 @@ be that you need additional SDL libraries. See the entry's index.html for
details. If something is not noted you're welcome to report it as an issue or
fix it and make a new pull request.
See the [FAQ 6.10 How does someone make a change to a file and submit that change
as a GitHub pull request](#ull_request) for more information about pull requests.
### <a name="faq3_9"></a><a name="curses"></a>FAQ 3.9: How do I compile an IOCCC entry that requires (n)curses?
@@ -2177,7 +2189,11 @@ fix. If it is accepted we'll be happy to credit you in the
[thanks](thanks-for-help.html) file. If you're a previous author of a winning IOCCC entry we will happily
link to your entries; if you're not we can link to your website if you wish.
See [FAQ 5.2](#fix_an_entry) for information on how to submit a fix to an IOCCC entry.
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry) for information on how to submit a fix to an
IOCCC entry. See also the [FAQ 6.10 How does someone make a change
to a file and submit that change as a GitHub pull request](#ull_request)
for more information about pull requests.
### <a name="faq5_2"></a><a name="fix_an_entry"></a>FAQ 5.2: How may I submit a fix to an IOCCC entry?
@@ -2215,6 +2231,11 @@ And of course, an IOCCC author may update their own entries
against the master [branch](https://github.com/ioccc-src/winner/branches)
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner).
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry). See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
Note that we're much more inclined to accept an author's fixes but the judges
have the final say in the matter.
@@ -2251,6 +2272,11 @@ against the master [branch](https://github.com/ioccc-src/winner/branches)
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner)
to submit a fix.
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry). See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
#### Some HTML files should NOT be directly modified
Nearly all HTML files on the [IOCCC web site](https://www.ioccc.org)
@@ -2282,6 +2308,11 @@ For example, in [contact.html](contact.html), one may read:
This means that you could consider editing the referenced markdown file
in your [IOCCC pull request](#pull_request).
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry). See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
In some cases, the HTML file is **NOT** based on markdown content, but instead
came from JSON and other data files. So instead of the above reference to a
markdown file, you will read:
@@ -2323,6 +2354,11 @@ by opening a [GitHub pull request](https://github.com/ioccc-src/winner/pulls)
against the master [branch](https://github.com/ioccc-src/winner/branches)
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner).
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry). See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
## <a name="faq5_6"></a><a name="fix_link"></a>FAQ 5.6: What should I do if I find a broken or wrong web link?
@@ -2331,7 +2367,9 @@ We would appreciate if you try to fix the broken (the link goes nowhere) or wron
If wish to fix such links, you may open a GitHub pull request as described in
[FAQ 5.4](#fix_web_site). In the case of dead links or invalid links it doesn't matter
if it's a specific winner or not; the procedure is the same: open a pull request
to fix the problem.
to fix the problem. See also the [FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
As far as how to find the updated link you can try using the [Internet Wayback
Machine](https://web.archive.org) and see if you can find the last non 4xx non