From 7c886e9f805ab50c7ace8ce5257de7463d77a1e3 Mon Sep 17 00:00:00 2001 From: Anthony Howe Date: Sat, 29 Nov 2025 04:09:15 -0500 Subject: [PATCH] Part 1 Guidelines review. --- markdown.md | 4 +- next/guidelines.md | 246 +++++++++++++++++---------------------------- 2 files changed, 92 insertions(+), 158 deletions(-) diff --git a/markdown.md b/markdown.md index e870bf167..0b279d631 100644 --- a/markdown.md +++ b/markdown.md @@ -25,8 +25,8 @@ Nevertheless, the IOCCC does have certain practices that we ask authors to follow. Some of these relate to use of markdown directly and others relate to injecting HTML into the markdown file. -In the sections below, examples will mark by ❌ for the incorrect method -and ✔ for preferred correct one. +In the sections below, examples will mark by ❌ for the incorrect method +and ✔ for preferred correct one.
diff --git a/next/guidelines.md b/next/guidelines.md index 37d4cc16b..0a7386917 100644 --- a/next/guidelines.md +++ b/next/guidelines.md @@ -1,31 +1,4 @@ - -# The IOCCC is closed - -The IOCCC is **NOT** accepting new submissions at this time. See the -[IOCCC winning entries page](../years.html) for the entries that have won the -IOCCC in the past. - -These guidelines are a **TENTATIVE proposal** for the next IOCCC -and are **likely be to be updated** before the next IOCCC. - -See our -FAQ on "[rules, guidelines, tools feedback](../faq.html#feedback)" -as well as our -FAQ on "[about asking questions](../faq.html#question)" -about these guidelines. You might also find the FAQ in general useful, especially the -FAQ on "[how to enter the IOCCC](../quick-start.html#enter)". - -Watch both [the IOCCC status page](../status.html) and the -[@IOCCC mastodon feed](https://fosstodon.org/@ioccc) for information about -future IOCCC openings. - -**HINT to mastodon users**: You may wish to refresh the [@IOCCC -mastodon feed](https://fosstodon.org/@ioccc) page and/or mastodon -app from time to time to view IOCCC mastodon updates. - - - # 29th International Obfuscated C Code Contest Official Guidelines

@@ -33,12 +6,12 @@ Copyright © 2025 Leonid A. Broukhis and Landon Curt Noll.

All Rights Reserved. Permission for personal, education or non-profit use is -granted provided this this copyright and notice are included in its entirety +granted provided this copyright and notice are included in its entirety and remains unaltered. All other uses must receive prior permission in writing by [contacting the judges](../contact.html). -# IOCCC Guidelines version +# Guidelines Version

These IOCCC guidelines are version **29.00 2025-11-28**. @@ -52,28 +25,23 @@ The | symbol indicates an **c Because the **IOCCC29** guidelines was a substantial rewrite, only **important changes** from **IOCCC28** have been marked.

-Be sure to read the [IOCCC rules](guidelines.html). +Be sure to read the [IOCCC rules](rules.html). -
-
+
+
+ # Guidelines for [Rule 2 - Size](rules.html#rule-2---size) -
-

You should pay attention to our observations on [code size and Rule 2 remarks for IOCCC28](../2024/index.html#code-size-and-rule-2).

-Your submission must satisfy **BOTH** the maximum size -[Rule 2a Gross Size](rules.html#rule-2a-gross-size) -**AND** -the IOCCC size -[Rule 2b Next Size](rules.html#rule-2b-net-size). +Your submission must satisfy **BOTH** the maximum size [Rule 2a Gross Size](rules.html#rule-2a-gross-size) +**AND** the [Rule 2b Net Size](rules.html#rule-2b-net-size). -To check your code against -[Rule 2 - Size](rules.html#rule-2---size), use the `iocccentry(1)` tool. +To check your code against [Rule 2 - Size](rules.html#rule-2---size), use the `iocccentry(1)` tool. For example: ``` @@ -96,13 +64,10 @@ counted by the IOCCC size tool. In cases where the above summary and the algorithm implemented by the IOCCC size tool `iocccsize(1)` conflict, the algorithm implemented by the current version of `iocccsize(1)` is preferred by the [IOCCC judges](../judges.html). +Make sure `iocccsize(1)` does not flag any issues with your `prog.c`. -Make sure `iocccsize` does not flag any issues with your `prog.c`. - -There a much less need to `#define` C reserved words in an effort -to get around the size limits of -[Rule 2 - Size](rules.html#rule-2---size) -because of the `iocccsize(1)` algorithm. +There a much less need to `#define` C reserved words in an effort to get +around the size limits of [Rule 2 - Size](rules.html#rule-2---size) because of the `iocccsize(1)` algorithm. Yes Virginia, **the previous guideline sentence is an important hint**! @@ -110,11 +75,10 @@ Yes Virginia, **the previous guideline sentence is an important hint**! Jump to: [top](#) -
-
+
+
+ # Guidelines for [Rule 3 - Register](rules.html#rule-3---register) -
-
See FAQ on "[What is an author handle?](../faq.html#author_handle_faq)". @@ -122,11 +86,10 @@ See FAQ on "[What is an author handle?](../faq.html#author_handle_faq)". Jump to: [top](#) -
-
+
+
+ # Guidelines for [Rule 7 - Original Work](rules.html#rule-7---original-work) -
-
While it is **NOT** required, you are allowed to use tools or services such as: @@ -141,11 +104,10 @@ While it is **NOT** required, you are allowed to use tools or services such as: The IOCCC has a rich history of remarkable winning entries created by authors who skillfully employed various techniques to develop their code. +If you do make use of such tools or services, then we **ENCOURAGE you to +describe how you used such tools** in your `remarks.md` file. -If you do make use of such tools or services, then we **ENCOURAGE you to describe -how you used such tools** in your `remarks.md` file. - -In short: You created it, you own it, and its an original work, or you have explicit permission. +In short: You created it, you own it, its an original work, or you have explicit permission to the work. See FAQ on "[May I use AI, LLM, Virtual coding assistants, or similar tools to write my submission?](../faq.html#ai)". @@ -153,39 +115,31 @@ See FAQ on "[May I use AI, LLM, Virtual coding assistants, or similar tools to w Jump to: [top](#) -
-
-# Guidelines for [Rule 11 - Abuse](rules.html#rule-11---abuse) -
-
+
+
-We try to avoid limiting creativity in our [IOCCC rules](rules.html) so -we leave the contest open for creative rule interpretation. +# Guidelines for [Rule 11 - Abuse](rules.html#rule-11---abuse) We do realize that there are holes in the [IOCCC rules](rules.html), and invite -submitters to attempt to exploit them. +submitters to attempt to apply creative rule interpretation. A rule abuse though, even +if not rewarded, may result in a subsequent rule change for future contests. -We sometime award '**Best abuse of the rules**' or '**Worst abuse of the rules**', +We sometimes award '**Best abuse of the rules**' or '**Worst abuse of the rules**', or some variation to a submission that creatively attempts to exploit a holes in the [IOCCC rules](rules.html). -When we do need to plug a hole in the [IOCCC rules](rules.html) or -[IOCCC guidelines](guidelines.html), we will attempt to use a very small plug, +When we do need to plug a hole in the [IOCCC rules](rules.html) +or [IOCCC guidelines](guidelines.html), we will attempt to use a very small plug, if not smaller. Or, maybe not. :-) -Legal abuse of the [IOCCC rules](rules.html) is somewhat encouraged. Legal rule abuse -may involve, but is not limited to, doing things that are technically allowed by -the [IOCCC rules](rules.html) and yet do not fit the spirit of what we intended to be -submitted. - -Legal rule abuse is encouraged to help promote creativity. Rule abuse -submissions, regardless of if they receive an award, result in changes to -the next year's [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html). +Legal rule abuse may involve, but is not limited to, doing things that are +technically allowed by the [IOCCC rules](rules.html) and yet do not fit the spirit of what +we intended to be submitted. Legal abuse of the [IOCCC rules](rules.html) is **NOT** an invitation to violate the -[IOCCC rules](rules.html). A submission that violates the [rules](rules.html) in the +[IOCCC rules](rules.html) (especailly [Rule 17 - Packaging](./rules.html#rule-17---packaging) ). A submission that violates the [rules](rules.html) in the opinion of the [IOCCC judges](../judges.html), **WILL** be disqualified. **_RULE ABUSE CARRIES A CERTAIN LEVEL OF RISK!_** If you have a submission that might otherwise be interesting, you might want to @@ -193,32 +147,28 @@ submit two versions; one that does not abuse the [IOCCC rules](rules.html) and o does. If you intend to abuse the [IOCCC rules](rules.html), -indicate so in your `remarks.md` file. You **MUST** try to justify +indicate so in your `remarks.md` file. You **MUST** try to justify, plead, beg, why you consider your rule abuse to be allowed under the -[IOCCC rules](rules.html). That is, you must plead your case as to why -your submission is valid. Humor and/or creativity help plead a case. +[IOCCC rules](rules.html). Humor or creativity help plead a case. As there is no guarantee that you will succeed, you might consider submitting an alternate version that conforms to the [IOCCC rules](rules.html). If you do bypass the `mkiocccentry(1)` warnings about [Rule 2a Gross Size](rules.html#rule-2a-gross-size) -and/or about -[Rule 2b Next Size](rules.html#rule-2b-net-size) +or about +[Rule 2b Net Size](rules.html#rule-2b-net-size) or any other rule and submit a submission anyway, you **MUST** try to justify why the IOCCC [IOCCC judges](../judges.html) should not reject your submission due to a rule violation, and you would be wise to do this towards the top of your `remarks.md` file. -Abusing the web submission procedure tends to annoy us more -than amuse us. Spend your creative energy on content of your -submission rather than on the submission process itself. - We are often asked why the contest [IOCCC rules](rules.html) and [IOCCC -guidelines](guidelines.html) seem strange or contain mistakes, flaws or -grammatical errors. One reason is that we sometimes make genuine mistakes. But +guidelines](guidelines.html) seem strange or contain mistakes, flaws, or +grammatical errors. One reason is that we sometimes make genuine mistakes, but in many cases such problems, flaws or areas of confusion are deliberate. + Changes to [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html) in response to rule abuses, are done in a minimal fashion. Often we will deliberately leave behind holes (or introduce new ones) so that future rule @@ -232,7 +182,7 @@ are only part of the overall contest. Even so, one might think the contest [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html) process as a parody of the sometimes tragic mismatch between what a customer (or marketing) wants and what engineering delivers. Real programmers must face obfuscated and -sometimes conflicting specifications and requirements from marketing, sales, +sometimes conflicting, balloning specifications, and requirements from marketing, sales, product management and even from customers themselves on an all too regular basis. This is one of the reasons why the [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html) are written in obfuscated form. @@ -241,13 +191,12 @@ This is one of the reasons why the [IOCCC rules](rules.html) and Jump to: [top](#) -
-
-# Guidelines for [Rule 15 - Building](rules.html#rule-15---building) -
-
+
+
-You may use git, or services such as [GitHub](https://www.github.com) +# Guidelines for [Rule 15 - Building](rules.html#rule-15---building) + +You may use `git,` or services such as [GitHub](https://www.github.com) to develop and maintain your submission. However, we **DISLIKE** submissions that **require** such services in order to build/compile your submission. @@ -255,7 +204,7 @@ Submissions will be judged in an environment that has no **IDE**. Any submission that fails to compile/build because it requires an **IDE** will be rejected. -We will use the `make(1)` tool, your `Makefile`, as well as tools found in the +We will use the `GNU make(1)` tool, your `Makefile`, as well as tools found in the [Single UNIX Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) environments, and commonly found on systems that reasonably conform to the [Single UNIX Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) @@ -265,15 +214,14 @@ in the building and compiling of your submission. Jump to: [top](#) -
-
+
+
+ # Guidelines for [Rule 17 - Packaging](rules.html#rule-17---packaging) -
-
We **STRONGLY** recommend you **do** install the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -as use of using older versions of the mkiocccentry toolkit to are **HIGHLY LIKELY** to be **REJECTED**! +As use of using older versions of the mkiocccentry toolkit to are **HIGHLY LIKELY** to be **REJECTED**! If you submit your own JSON files (other than `.auth.json` and `.info.json`) then they do **NOT** have to be valid JSON. @@ -289,11 +237,9 @@ file_.

-The non-extra files (`prog.c`, `prog.alt.c`, -`try.sh`, `try.alt.sh`, `remarks.md`, `Makefile`, `.auth.json` and `.info.json`) -are considered _free files_, and to not count towards the -[Rule 17 - Packaging](rules.html#rule-17---packaging) -limit of **31** _extra files_. +These files (`prog.c`, `prog.alt.c`, `try.sh`, `try.alt.sh`, `remarks.md`, +`Makefile`, `.auth.json` and `.info.json`) do _not_ count towards the +[Rule 17 - Packaging](rules.html#rule-17---packaging) limit of **31** _extra files_.

If you use an optional filename for something other than their intended use @@ -332,25 +278,21 @@ See FAQ on "[What are the details behind Rule 17 - Packaging?](../faq.html#rule1 Jump to: [top](#) -
-
+
+
+ # Guidelines for the mkiocccentry toolkit -
-
The [IOCCC submit server](https://submit.ioccc.org), and related services use the **most recent version** of the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry): submissions that package using older versions of the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -are **LIKELY** to be **REJECTED**! - -You **REALLY SHOULD** use latest [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) +are **LIKELY** to be **REJECTED**! So you **REALLY SHOULD** use the latest [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) to package your own submission. The `mkiocccentry(1)` tool runs a number of checks by way of these -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -tools: +[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) tools: * iocccsize(1) * txzchk(1) @@ -358,38 +300,34 @@ tools: * chksubmit(1) * chkentry(1) -Do **NOT** use `txzchk(1)` command line options that are labeled "**for TESTING purposes**" -in the `txzchk(1)` man page. +Do **NOT** use `txzchk(1)` or `fnamchk(1)` command line options that are labeled +"**for TESTING purposes**" in their respective man pages. -Do **NOT** use `fnamchk(1)` command line options that are labeled "**for TESTING purposes**" -in the `fnamchk(1)` man page. - -Do **NOT** use `chkentry(1)` command line options that are labeled "**for the use by the IOCCC judges only**" -in the `chkentry(1)` man page. +Similarly do **NOT** use `chkentry(1)` command line options marked "**for the use +by the IOCCC judges only**" in the `chkentry(1)` man page. To view [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) man pages, while your current directory is the top of the source tree: ``` - man soup/man/man1/mkiocccentry.1 - man soup/man/man1/iocccsize.1 - man soup/man/man1/txzchk.1 - man test_ioccc/man/man1/fnamchk.1 - man soup/man/man1/chksubmit.1 - man soup/man/man1/chkentry.1 +man soup/man/man1/mkiocccentry.1 +man soup/man/man1/iocccsize.1 +man soup/man/man1/txzchk.1 +man test_ioccc/man/man1/fnamchk.1 +man soup/man/man1/chksubmit.1 +man soup/man/man1/chkentry.1 ``` The above `man(1)` commands will show the toolkit man pages without having to install them first. So that you do not have to repeatedly answer all the `mkiocccentry(1)` questions, use `mkiocccentry -a answers ...` to create a file containing the answers you first give, -that will allow you to later use `mkiocccentry -i answers ...` to reuse those same answers. +so later enter `mkiocccentry -i answers ...` to reuse those same answers. The `mkiocccentry -A answers ..` does the same thing except that the **answers file will be overwritten**. The `mkiocccentry -i answers ..` will still be required to confirm "_Yes/No_" questions. - -Use `mkiocccentry -Y -i answers ..` to force a yes answers with **great caution** +While `mkiocccentry -Y -i answers ..` will force yes answers, use with **great caution**, because it might force a yes answer to something you do **NOT** want. To help with not having to repeatedly enter a UUID, put your UUID into a file and use @@ -397,12 +335,12 @@ To help with not having to repeatedly enter a UUID, put your UUID into a file an on the command line. If you wish to **test** that your submission passes the `mkiocccentry(1)` tests -without having to type in in answers each time, you can use the `-d` or `-s seed` +without having to type in answers each time, you can use the `-d` or `-s seed` option to `mkiocccentry` for the tool to pseudo-randomly create answers for you. For example: ``` - mkiocccentry -d workdir topdir +mkiocccentry -d workdir topdir ``` Do **NOT** submit a tarball formed by `mkiocccentry -d ..`, **NOR** by `mkiocccentry -s seed ..`! @@ -411,7 +349,7 @@ The `mkiocccentry(1)` tool creates an `xz(1)` compressed **v7 format** tarball u command of the form: ``` - cd workdir/UUID-slot_num && tar --format=v7 -cJf submit.UUID-slot_num.timestamp.txz UUID-slot_num +cd workdir/UUID-slot_num && tar --format=v7 -cJf submit.UUID-slot_num.timestamp.txz UUID-slot_num ``` In many places the `mkiocccentry(1)` tool will prompt you to verify what you input, allowing you to @@ -422,7 +360,7 @@ however make sure the default is the **CORRECT** answer. The `mkiocccentry(1)` tool will use code from `iocccsize(1)` which detects a number of issues (such as [Rule 2 - Size](rules.html#rule-2---size)) that you may ignore, -however ignoring such issues **comes with a significant level of risk!** +however ignoring such issues **comes with a significant level of risk** as noted else where. Once the tarball is packaged it will run `txzchk(1)`, which will also run `fnamchk(1)`, as part of its algorithm. @@ -431,7 +369,7 @@ The use of `mkiocccentry -W ...` is **highly discouraged** as this may ignore warnings about a problem that may cause your submission to be **REJECTED!**" If `mkiocccentry` encounters an **error**, the program will exit and the xz -compressed tarball **will NOT be formed**: this is a **feature, not a bug**! +compressed tarball **will NOT be generated**: this is a **feature, not a bug**! If you encounter a **bug** with the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) @@ -444,11 +382,9 @@ you will have to specify `mkiocccentry(1)` command line options to locate requir such as `chkentry(1)` (`mkiocccentry -C chkentry ..`), `txzchk(1)` (`mkiocccentry -T txzchk ..`), and `fnamchk(1)` (`mkiocccentry -F fnamchk ..`). -The `mkiocccentry(1)` tool will ignore any filename that begins with a "." (dot). +The `mkiocccentry(1)` tool will ignore any filename or directory that begins with a period (`.`). -The `mkiocccentry(1)` tool will ignore any directory tree with a directory name that begins with a "." (dot). - -The `mkiocccentry(1)` tool will all files that begin with `COPYING`, `COPYRIGHT`, and `LICENSE`, regardless +The `mkiocccentry(1)` tool will ignore all files that begin with `COPYING`, `COPYRIGHT`, and `LICENSE`, regardless of filename case. The `mkiocccentry(1)` tool will any of the following files if they are found directly under @@ -506,9 +442,9 @@ See FAQ on "[What is the mkiocccentry tool, how do I obtain it and how do I use Jump to: [top](#) -
+
+ # General Overall Guidelines -
These [guideline](guidelines.html) are **hints** and **suggestions**, **NOT** [IOCCC rules](rules.html). @@ -604,11 +540,10 @@ to a great submission! Jump to: [top](#) -
-
+
+
+ # OUR LIKES AND DISLIKES: -
-
We **VERY MUCH LIKE** submissions that use an edited variant of the example Makefile, as described and linked to in the [Makefile section](#makefile), @@ -971,8 +906,8 @@ Users of such tools should strip off such control-M's before submitting their submissions. In some cases tools have a "Save As" option that will prevent such trailing control-M's being added. -One should restrict libcurses to portable features found on BSD -or Linux curses. +One should restrict libcurses to portable features found on both BSD +and Linux curses.

If you do `#include ` make **CERTAIN** you link in curses (i.e. @@ -1101,9 +1036,9 @@ Try to be even more creative! Jump to: [top](#) -

+
+ # Fun😄damental Guidelines -
The reason for the times of day are so that key IOCCC events are **calculated** to be a **fun**ctional UTC time. :-) @@ -1236,11 +1171,10 @@ it? :-) Jump to: [top](#) -
-
+
+
+ # FOR MORE INFORMATION: -
-
For questions or comments about the contest, see [Contacting the IOCCC](../contact.html).