From 804ac3629563b1a77ca8abf12bb9bda937505574 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Wed, 31 Jul 2024 10:50:12 -0700 Subject: [PATCH] Update FAQ on reporting mkiocccentry bugs It now refers to that repo's FAQ about this topic - where it belongs. --- faq.html | 29 ++++++++--------------------- faq.md | 25 +++---------------------- 2 files changed, 11 insertions(+), 43 deletions(-) diff --git a/faq.html b/faq.html index 4927cd431..07e458e3f 100644 --- a/faq.html +++ b/faq.html @@ -834,22 +834,9 @@ crucial in the contest, both for submitters and the judges, if you find a bug (or you think you find a bug) we would be grateful if you were to report it at the mkiocccentry issues page.

-

When opening an issue for what you think is a bug, PLEASE use the ‘Bug report’ -option -and PLEASE state in the title what tool you think has a bug.

-

When reporting a bug, PLEASE make sure to run the bug_report.sh script. -This is extremely helpful and without it it makes it much harder to determine -the problem (at least in some cases :-) ). Describing the problem in as much -detail as you can and attaching any relevant screenshots, other files (in -addition to the bug report log file) and so on will also be very helpful.

-

To run the bug_report.sh script, switch to the mkiocccentry directory and -then run:

-
     ./bug_report.sh
-

Let it do its thing and when it’s done it will tell you the name of the log -file. If it does not find a problem but you think there is a problem, please -still do feel free to report it and do make sure you attach the log nonetheless. -If it does find problems, it will give you a summary of the problems and when -you attach the log file we will see those too.

+

Please see the +FAQ on “reporting bugs and other issues in the mkiocccentry repo” +in the mkiocccentry repo.

FAQ 0.9: What is a .auth.json file?

@@ -3032,9 +3019,9 @@ provided by the author and any other file in the winning entry, found under the entry’s subdirectory.

If you downloaded 1984/mullender/1984_mullender.tar.bz2, for instance, you might then do:

-
        cd 1984/mullender
-        make everything
-        ./mullender.alt
+
        cd 1984/mullender
+        make everything
+        ./mullender.alt

to compile all versions and then run the alternate version (if you have a PDP-11 or VAX-11 you would be able to run the original version). For more help on compiling entries, see also the @@ -3075,8 +3062,8 @@ if you switched to each entry’s directory and ran make everything

If you download the 1984 tarball, i.e. 1984/1984.tar.bz2, then you might extract it and then switch to the directory and compile everything of each entry:

-
        cd 1984
-        make everything
+
        cd 1984
+        make everything

For more help on compiling entries, see also the FAQ on “IOCCC Makefile rules”.

Of course in this case you can also switch to individual entries and look at the diff --git a/faq.md b/faq.md index 83625879f..2b44fbc9f 100644 --- a/faq.md +++ b/faq.md @@ -578,28 +578,9 @@ crucial in the contest, both for submitters and the judges, if you find a bug the [mkiocccentry issues page](https://github.com/ioccc-src/mkiocccentry/issues). -When opening an issue for what you think is a bug, **PLEASE** use the ['Bug report' -option](https://github.com/ioccc-src/mkiocccentry/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+%3Ctitle%3E) -and **PLEASE state in the _title_ what tool you think has a bug**. - -When reporting a bug, **PLEASE make sure to run the `bug_report.sh` script**. -**This is extremely helpful** and without it it makes it much harder to determine -the problem (at least in some cases :-) ). Describing the problem in as much -detail as you can and attaching any relevant screenshots, other files (in -addition to the bug report log file) and so on will also be very helpful. - -To run the `bug_report.sh` script, switch to the `mkiocccentry` directory and -then run: - -``` - ./bug_report.sh -``` - -Let it do its thing and when it's done it will tell you the name of the log -file. If it does not find a problem but you think there is a problem, please -still do feel free to report it and do make sure you attach the log nonetheless. -If it does find problems, it will give you a summary of the problems and when -you attach the log file we will see those too. +Please see the +FAQ on "[reporting bugs and other issues in the mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#bugs)" +in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry).