Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Rule Guideline] Modify Rule 17 to account for same subdirectories in submissions #40

Open
1 task done
lcn2 opened this issue Jan 2, 2025 · 6 comments
Open
1 task done
Assignees
Labels
rules & guidelines Problems with the IOCCC Rules and/or Guidelines top priority This a top priory critical path issue for next milestone

Comments

@lcn2
Copy link
Contributor

lcn2 commented Jan 2, 2025

Is there an existing issue for this?

  • I have searched for existing issues and did not find anything like it

Which Rule and/or Guideline has a problem?

Rule 17.

You submission may have additional files, however the filenames of those additional files MUST:

Be less than 100 characters in length.

Match the regular expression: ^[0-9A-Za-z][0-9A-Za-z._+-]*$

As well as:

Filenames in your entry (that is, not including the files generated by the mkiocccentry(1) tool or the tools it or any other tool invokes) MUST:

Be less than 100 characters in length

NOT have a / (excluding the entry directory that the mkiocccentry(1) tool generates).

NOT contain a path component of: . (that is, with the exception of files generated by mkiocccentry(1) itself, it must have NO .).

NOT contain a path component of: .. (that is, NO ..).

Match the regular expression ^[0-9A-Za-z][0-9A-Za-z._+-]*$ (again, excluding files generated by mkiocccentry(1)).

What is wrong with the Rule and/or Guideline?

Rule 17 disallows sane subdirectories in submissions.

How do you recommend we fix the problem?

Once issue 1060 in the mkiocccentry repo is resolved, then Rule 17 should be modified accordingly.

Anything else?

No response

@lcn2 lcn2 added top priority This a top priory critical path issue for next milestone rules & guidelines Problems with the IOCCC Rules and/or Guidelines labels Jan 2, 2025
@xexyl
Copy link
Contributor

xexyl commented Jan 2, 2025

Assign please.

I already have the mkiocccentry code updated. Now I am waiting on the function in jparse and then I can finish txzchk. I really will be going afk now! I have my right leg dangling out of my bed so that I have to.

Back later ... please do a pull request in jparse with that function you refer to as you have the idea in your head and I am not clear entirely what it should do. Thanks!

@lcn2
Copy link
Contributor Author

lcn2 commented Jan 2, 2025

P.S. In regards to @SirWumpus' idea of supplying a test suite with lots of files
, a FAQ and/or Guideline could be added to suggest that if an entry runs into the MAX_FILE_COUNT problems, the should turn a large set of files (such as some large test suite) into a tarball.

Such a tarball would be untarred some Makefile rule (say make test) AND then cleaned up via make clobber, restoring the entry to a sane number of files.

See GH-issuecomment-2567936096 in "the other repo".

@lcn2
Copy link
Contributor Author

lcn2 commented Jan 4, 2025

Status update

The code needed to implement this enhancement is being worked on in "the other repo" issue 1060.

Meanwhile we plan to modify the rules and update the guidelines and likely the FAQ to accompany the work being done in "the other repo" in the near future. So in this case the rules and guidelines will likely lead the work needed to implement. I.e., tools such as mkiocccentry(1), txzchk(1) and chkcentry(1) will need to be re-released to "catch up to" (as the expression goes) the rules and guidelines.

We are going to lead with modifying the rules and guidelines so that it becomes more clear what the change will become to the developers in "the other repo".

UPDATE 0

Stay tuned ..

P.s., Our goal is to have this issue, and the "the other repo" issue 1060 resolved and tested by mid-January, well ahead of the date when the contest is anticipated to open.

@xexyl
Copy link
Contributor

xexyl commented Jan 4, 2025

P.S. In regards to @SirWumpus' idea of supplying a test suite with lots of files , a FAQ and/or Guideline could be added to suggest that if an entry runs into the MAX_FILE_COUNT problems, the should turn a large set of files (such as some large test suite) into a tarball.

Such a tarball would be untarred some Makefile rule (say make test) AND then cleaned up via make clobber, restoring the entry to a sane number of files.

See GH-issuecomment-2567936096 in "the other repo".

If you forgot .. there's actually a test suite. It was built in long ago. It does not need to be a tarball per se as there's the read as text file mode a part of the test suite. There are already lots of test files and indeed more would be added when this is done.

@xexyl
Copy link
Contributor

xexyl commented Jan 4, 2025

P.S. In regards to @SirWumpus' idea of supplying a test suite with lots of files , a FAQ and/or Guideline could be added to suggest that if an entry runs into the MAX_FILE_COUNT problems, the should turn a large set of files (such as some large test suite) into a tarball.
Such a tarball would be untarred some Makefile rule (say make test) AND then cleaned up via make clobber, restoring the entry to a sane number of files.
See GH-issuecomment-2567936096 in "the other repo".

If you forgot .. there's actually a test suite. It was built in long ago. It does not need to be a tarball per se as there's the read as text file mode a part of the test suite. There are already lots of test files and indeed more would be added when this is done.

UPDATE 0

In fact it was one of the first things I did - so I could make sure it works okay (that and using the tarballs you provided).

@lcn2
Copy link
Contributor Author

lcn2 commented Jan 16, 2025

We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rules & guidelines Problems with the IOCCC Rules and/or Guidelines top priority This a top priory critical path issue for next milestone
Projects
None yet
Development

No branches or pull requests

2 participants