Makefile Guidelines, clobber, and git

[SirWumpus]

The Guidelines explain the need to use Makefile.example as a template for an entry's Makefile and how the clobber target should clean up everything to return to a pristine directory state. Some contestants might carelessly forget that they should NOT:

clobber:
        -git clean -f

This is dependent of course on how the winners are distributed, but in the case of git clone of winners, a git clean -f will clean their entire winners repo tree. Not just the directory they're in, which might not be what they want.

[vog]

Indeed. Maybe the easiest way to mitigate this is to specify the directory, e.g. something like this:

clobber:
        -git clean -f .

or this:

clobber:
        -git clean -f '$(PWD)'

[SirWumpus]

You method has merit, but still prone to forgetfulness.

I was thinking more like do not use git to clean-up generated files from within the Makefile and that this need be stated in the Guidelines.

[xexyl]

The reason not to do this is because not everyone has git. Also you can download the tarball without using git.

[xexyl]

The Guidelines explain the need to use Makefile.example as a template for an entry's Makefile and how the clobber target should clean up everything to return to a pristine directory state. Some contestants might carelessly forget that they should NOT:

clobber:
        -git clean -f

This is dependent of course on how the winners are distributed, but in the case of git clone of winners, a git clean -f will clean their entire winners repo tree. Not just the directory they're in, which might not be what they want.

Yes also this. It's specific to each directory.

[xexyl]

The Guidelines explain the need to use Makefile.example as a template for an entry's Makefile and how the clobber target should clean up everything to return to a pristine directory state. Some contestants might carelessly forget that they should NOT:

clobber:
        -git clean -f

This is dependent of course on how the winners are distributed, but in the case of git clone of winners, a git clean -f will clean their entire winners repo tree. Not just the directory they're in, which might not be what they want.

Yes also this. It's specific to each directory.

And finally another reason is it removes files not part of the repo! This is very bad. The make clobber rule should not affect what is outside the entry's directory and only what the clobber rule needs to clean up. I have many files and I would be extremely unhappy if they were wiped out simply from running make clobber.

[lcn2]

Not all will develop their submissions under hit control, not to mention issues that arise from doing a got clean -f previous mentioned.

When submitting, dot-directories such as .git will be ignored by mkioccentry(1). If someone attempts to force .git into their submission, when the IOCCC judges run txzchk(1) the uploaded compressed tarball, the submission will be rejected. So as received by the IOCCC judges, a submission will NOT be a git repo and so git commands won't work in the submission Makefile.

[xexyl]

It might be a good idea to mention in the guidelines that:

While people are free to mange their submission under git(1) or even use a GitHub repo, dot-files dot-directories such as .git are not allowed in a submission.

The mkiocccentry(1) tool will ignore dot-files and dot-directories (such as .vimrc or .bashrc or .git or .github) and not be put into the submission's compressed tarball. So while you may use such files and directories to help develop your submission, they won't be included when to run the mkiocccentry(1) tool.

You may use whatever tools you need to develop your submission, including the use of git(1) or gh(1), just be sure that your submission code and your submission Makefile don't depend on such tools.

When the judges run txzchk(1) on the uploaded submission compressed tarball, any files and dot-directories that might be "snuck in" will cause the submission to be rejected under rule XX.

Rule 17 in particular I guess?

[lcn2]

Rule 17 in particular I guess?

Yes.

[xexyl]

Rule 17 in particular I guess?

Yes.

Where in the guidelines do you wish it to be placed? Somewhere under the mkiocccentry section or the txzchk section? I guess the mkiocccentry as it talks about that and how it will not package them. Is that what you think?

If so I'lll try addressing it tomorrow or the next day if not later today.

[lcn2]

Rule 17 in particular I guess?

Yes.

Where in the guidelines do you wish it to be placed? Somewhere under the mkiocccentry section or the txzchk section? I guess the mkiocccentry as it talks about that and how it will not package them. Is that what you think?

We suggest below the "The clobber rule" section since it focuses ultimately on Makefile stuff too.

Perhaps you need an explicit section, under the "The clobber rule", called something like "Allowed and ignored filenames"?

If so I'lll try addressing it tomorrow or the next day if not later today.

Thanks.

[xexyl]

Where in the guidelines do you wish it to be placed? Somewhere under the mkiocccentry section or the txzchk section? I guess the mkiocccentry as it talks about that and how it will not package them. Is that what you think?

We suggest below the "The clobber rule" section since it focuses ultimately on Makefile stuff too.

Yes that makes sense. However .. see below.

Perhaps you need an explicit section, under the "The clobber rule", called something like "Allowed and ignored filenames"?

Do you mean filenames that are not allowed in a submission? I know the rules have something about this but I also know the details have changed as well. But since you have it under the clobber rule it might be something different (or maybe it's obvious when I look at it).

QUESTIONS for you @lcn2

How do you want this list to be presented? And is it indeed the list of files that are allowed in the submission? What about in relation to make clobber?

Thanks!

If so I'lll try addressing it tomorrow or the next day if not later today.

Thanks.

I hope I can. Atm I do feel a bit more awake than the past few days but that could also change of course. I must go afk for a while soon too (minutes from now). It (whether I can get to this today) depends on also whether I get a reply in the above. I might be able to do some of it before though and then modify it either today or tomorrow depending on when you get back to me.

[lcn2]

Some contestants might carelessly forget that they should NOT:

clobber:
-git clean -f

Given @SirWumpus apt warning, the guidelines should also state, after the suggested additional guideline text recommend by GH-discussioncomment-11920317, the following guideline:

And in case we have not made ourselves clear, your submission Makefile should NOT do:

# Do NOT do this!
clobber:
        -git clean -f

Instead when doing a make clobber, use make actions such as ${RM} -f files and ${RM} -rf directories.

[xexyl]

He did yes .. and so did I but strangely I don't see the one (about how doing so would wipe out files in someone's copy that are not part of the repo). I can add this (what you said) but perhaps you could state where this might be? I'd be happy to put it in when doing the other part too.

[lcn2]

He did yes .. and so did I but strangely I don't see the one (about how doing so would wipe out files in someone's copy that are not part of the repo). I can add this (what you said) but perhaps you could state where this might be? I'd be happy to put it in when doing the other part too.

See GH-discussioncomment-11920567.

[xexyl]

Should now look like ...