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

Merge pull request #2242 from xexyl/update-faq

Browse Source 
Minor fixes and updates to FAQ
This commit is contained in:
Landon Curt Noll authored and GitHub committed 2024-03-08 10:53:23 -08:00
2 parents 059f3e4079 40e3808b78
commit 60ba3dbb45
3 files changed
+47 -22
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Makefile
+7 -1
View File
@@ -238,7 +238,7 @@ indent.c:
# simple want to examine, run / test winning IOCCC entries.
.PHONY: help genpath genfilelist verify_entry_files gen_authors gen_location gen_years \
entry_index gen_top_html gen_other_html quick_entry_index \
entry_index gen_top_html thanks gen_other_html quick_entry_index \
gen_year_index quick_www www gen_sitemap \
form_entry_tarball form_year_tarball form_all_tarball tar
@@ -356,6 +356,12 @@ gen_top_html: ${GEN_TOP_HTML}
${GEN_TOP_HTML} -v 1
@echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-='
thanks: ${GEN_TOP_HTML} thanks-for-help.md
@echo "Thanks for all the help ..."
@${GEN_TOP_HTML}
@echo "... and thanks for all the fish :-)"
# generate build entry HTML files from markdown other than README.md to index.html HTML files
#
gen_other_html: ${GEN_OTHER_HTML}
faq.html
+14 -9
View File
@@ -2033,7 +2033,7 @@ file includes just missing files and we welcome these too!</p>
write-up</strong> of how IOCCC winning entries are presented!</p>
<p>In any event we will happily add you to the <a
href="thanks-for-help.html">thanks</a> file for your help!</p>
<p>And of course, an IOCCC entry may update their own entries (metadata
<p>And of course, an IOCCC author may update their own entries (metadata
as well as source code and any extra files) by opening a <a
href="https://github.com/ioccc-src/winner/pulls">GitHub pull request</a>
against the master <a
@@ -2203,7 +2203,7 @@ instructional material?</h3>
material, we request that you ask the <a href="judges.html">IOCCC
judges</a> first.</p>
<p>Please send your request using the instructions on the <a
href="contact.html">contacting the IOCCC Judges</a> page.</p>
href="/contact.html">contacting the IOCCC Judges</a> page.</p>
<h3
id="faq-6.4-why-do-you-sometimes-use-the-first-person-plural"><a name="faq6_4"></a>FAQ
6.4: Why do you sometimes use the first person plural?</h3>
@@ -2217,13 +2217,13 @@ href="https://en.wikipedia.org/wiki/F._D._C._Willard">F. D. C.
Willard</a> as well as the <a
href="https://journals.aps.org/2014/04/01/aps-announces-a-new-open-access-initiative">APS
New Open Access Initiative</a>.</p>
<p>The number of <a href="../judges.html">IOCCC judges</a> has always
been “&gt; 1” such that IOCCC judges often prefer to themselves in the
plural, sometimes <a href="https://en.wikipedia.org/wiki/Plural">in the
common plural</a>, sometimes in the <a
href="https://en.wikipedia.org/wiki/Nosism">first person plural</a>,
there may be some who reject such a practice. Therefore please consider
that when you believe that just one of the <a
<p>The number of <a href="https://www.ioccc.org/judges.html">IOCCC
judges</a> has always been “&gt; 1” such that IOCCC judges often prefer
to themselves in the plural, sometimes <a
href="https://en.wikipedia.org/wiki/Plural">in the common plural</a>,
sometimes in the <a href="https://en.wikipedia.org/wiki/Nosism">first
person plural</a>, there may be some who reject such a practice.
Therefore please consider that when you believe that just one of the <a
href="../judges.html">IOCCC judges</a> is in action, you may consider
that <a href="https://en.wikipedia.org/wiki/F._D._C._Willard">F. D. C.
Willard</a> has been consulted, agreed, and has authorized the statement
@@ -2943,6 +2943,11 @@ link to the script that discusses this and gives supposed examples.</p>
</blockquote>
<p>Once you’ve done this you should click on <em>Create pull
request</em>.</p>
<p>IMPORTANT NOTE: although the <a
href="https://www.ioccc.org/judges.html">Judges</a> will give more
deference to the authors of edited entries the <a
href="https://www.ioccc.org/judges.html">Judges</a> also retain the
final editorial say in the matter.</p>
<h4 id="what-to-do-after-a-merge">What to do after a merge</h4>
<p>When the judges have merged the pull request you now need to make
sure your fork has the merge. To do this from the command line, assuming
faq.md
+26 -12
View File
@@ -948,9 +948,13 @@ 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 <a href="#fix_an_entry">"How may I submit a fix to an IOCCC
entry"</a> for details.
### <a name="faq3_3"></a>FAQ 3.3: Why do some IOCCC entries fail to compile under macOS?
@@ -962,9 +966,12 @@ actually clang, even `/usr/bin/gcc`.
That being said many (if not most) of these entries have been fixed and some
others will be looked at, when found.
In some cases the [bugs.html](bugs.html) file may note a known macOS problem with an entry. Should you manage to port the entry, and assuming your changes also attempt to preserve the original intent of the IOCCC entry, we would encourage you to submit a pull request with your ported code.
Please
see FAQ 5.2 <a href="#fix_an_entry">"How may I submit a fix to an IOCCC entry"</a> for details.
In some cases the [bugs.html](bugs.html) file may note a known macOS problem
with an entry. Should you manage to port the entry, and assuming your changes
also attempt to preserve the original intent of the IOCCC entry, we would
encourage you to submit a pull request with your ported code.
Please see FAQ 5.2 <a href="#fix_an_entry">"How may I submit a fix to an IOCCC
entry"</a> for details.
### <a name="faq3_4"></a>FAQ 3.4: Why does clang or gcc fail to compile an IOCCC entry?
@@ -983,9 +990,11 @@ At the same time some entries are not designed to work with clang. There might
be alternate code added at some point but as above this depends on free time and
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.
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.
### <a name="faq3_5"></a>FAQ 3.5: What is this cb tool that is mentioned in the IOCCC?
@@ -2185,7 +2194,7 @@ IOCCC winning entries are presented!
In any event we will happily add you to the
[thanks](thanks-for-help.html) file for your help!
And of course, an IOCCC entry may update their own entries
And of course, an IOCCC author may update their own entries
(metadata as well as source code and any extra files) by opening a
[GitHub pull request](https://github.com/ioccc-src/winner/pulls)
against the master [branch](https://github.com/ioccc-src/winner/branches)
@@ -2375,7 +2384,7 @@ While IOCCC judges look favorably on most requests to use IOCCC material,
we request that you ask the [IOCCC judges](judges.html) first.
Please send your request using the instructions on the [contacting
the IOCCC Judges](contact.html) page.
the IOCCC Judges](/contact.html) page.
### <a name="faq6_4"></a>FAQ 6.4: Why do you sometimes use the first person plural?
@@ -2389,7 +2398,7 @@ Willard](https://en.wikipedia.org/wiki/F._D._C._Willard) as well
as the [APS New Open Access
Initiative](https://journals.aps.org/2014/04/01/aps-announces-a-new-open-access-initiative).
The number of [IOCCC judges](../judges.html) has
The number of [IOCCC judges](https://www.ioccc.org/judges.html) has
always been "> 1" such that IOCCC judges often prefer to themselves
in the plural, sometimes [in the common
plural](https://en.wikipedia.org/wiki/Plural), sometimes in the
@@ -3286,6 +3295,11 @@ and then the text field that is labelled _Add a description_ would have:
Once you've done this you should click on _Create pull request_.
IMPORTANT NOTE: although the [Judges](https://www.ioccc.org/judges.html) will
give more deference to the authors of edited entries the
[Judges](https://www.ioccc.org/judges.html) also retain the final editorial say
in the matter.
#### What to do after a merge