]> granicus.if.org Git - nethack/commitdiff
rationalize extensions in doc directory
authornhkeni <keni@his.com>
Sat, 29 Jan 2022 21:28:06 +0000 (16:28 -0500)
committernhkeni <keni@his.com>
Sat, 29 Jan 2022 21:28:06 +0000 (16:28 -0500)
    rename text files to have .txt extension, etc
    update references to changed filenames

50 files changed:
Porting
doc/.gitattributes
doc/fixes1-0-0.txt [moved from doc/fixes10.0 with 100% similarity]
doc/fixes1-4-f.txt [moved from doc/fixes14.f with 100% similarity]
doc/fixes2-2-0.txt [moved from doc/fixes22.0 with 100% similarity]
doc/fixes2-3-e.txt [moved from doc/fixes23.e with 100% similarity]
doc/fixes3-0-0.txt [moved from doc/fixes30.0 with 100% similarity]
doc/fixes3-0-pl01.txt [moved from doc/fixes30.pl01 with 100% similarity]
doc/fixes3-0-pl02.txt [moved from doc/fixes30.pl02 with 100% similarity]
doc/fixes3-0-pl03.txt [moved from doc/fixes30.pl03 with 100% similarity]
doc/fixes3-0-pl04.txt [moved from doc/fixes30.pl04 with 100% similarity]
doc/fixes3-0-pl05.txt [moved from doc/fixes30.pl05 with 100% similarity]
doc/fixes3-0-pl06.txt [moved from doc/fixes30.pl06 with 100% similarity]
doc/fixes3-0-pl07.txt [moved from doc/fixes30.pl07 with 100% similarity]
doc/fixes3-0-pl08.txt [moved from doc/fixes30.pl08 with 100% similarity]
doc/fixes3-0-pl09.txt [moved from doc/fixes30.pl09 with 100% similarity]
doc/fixes3-0-pl10.txt [moved from doc/fixes30.pl10 with 100% similarity]
doc/fixes3-1-1.txt [moved from doc/fixes31.1 with 100% similarity]
doc/fixes3-1-2.txt [moved from doc/fixes31.2 with 100% similarity]
doc/fixes3-1-3.txt [moved from doc/fixes31.3 with 100% similarity]
doc/fixes3-2-0.txt [moved from doc/fixes32.0 with 100% similarity]
doc/fixes3-2-1.txt [moved from doc/fixes32.1 with 100% similarity]
doc/fixes3-2-2.txt [moved from doc/fixes32.2 with 100% similarity]
doc/fixes3-2-3.txt [moved from doc/fixes32.3 with 100% similarity]
doc/fixes3-3-0.txt [moved from doc/fixes33.0 with 100% similarity]
doc/fixes3-3-1.txt [moved from doc/fixes33.1 with 100% similarity]
doc/fixes3-4-0.txt [moved from doc/fixes34.0 with 100% similarity]
doc/fixes3-4-1.txt [moved from doc/fixes34.1 with 100% similarity]
doc/fixes3-4-2.txt [moved from doc/fixes34.2 with 100% similarity]
doc/fixes3-4-3.txt [moved from doc/fixes34.3 with 100% similarity]
doc/fixes3-5-0.txt [moved from doc/fixes35.0 with 100% similarity]
doc/fixes3-6-0.txt [moved from doc/fixes36.0 with 100% similarity]
doc/fixes3-6-1.txt [moved from doc/fixes36.1 with 100% similarity]
doc/fixes3-6-2.txt [moved from doc/fixes36.2 with 100% similarity]
doc/fixes3-6-3.txt [moved from doc/fixes36.3 with 100% similarity]
doc/fixes3-6-4.txt [moved from doc/fixes36.4 with 100% similarity]
doc/fixes3-6-5.txt [moved from doc/fixes36.5 with 100% similarity]
doc/fixes3-6-6.txt [moved from doc/fixes36.6 with 100% similarity]
doc/fixes3-7-0.txt [moved from doc/fixes37.0 with 99% similarity]
doc/fixesX-X-X.txt [moved from doc/fixesXX.X with 100% similarity]
doc/options.txt [moved from doc/options.doc with 100% similarity]
doc/window.txt [moved from doc/window.doc with 99% similarity]
include/optlist.h
include/winX.h
src/display.c
src/options.c
sys/libnh/README.md
win/X11/winX.c
win/curses/cursstat.c
win/tty/wintty.c

diff --git a/Porting b/Porting
index 2327ba53367182202709465d5109f07a09ef93c5..68556f4e593e67aaaed5ce1513a48d61473e1074 100644 (file)
--- a/Porting
+++ b/Porting
@@ -44,7 +44,7 @@ new machine.  The basic steps in porting the program are:
            add an OS-specific library (see "msdos.c" and "tos.c" as
            examples) to provide functions NetHack wants and your OS lacks.
 
-       4.  If your machine uses a new windowing system, follow doc/window.doc
+       4.  If your machine uses a new windowing system, follow doc/window.txt
            carefully.  Put files implementing these routines in a win or
            sys subdirectory as appropriate.
 
@@ -268,6 +268,6 @@ by code within the game itself. That was done to facilitate cross-compiling of
 NetHack on one platform for game execution on another.
 
 
-# NetHack 3.7  Porting       $NHDT-Date: 1596498144 2020/08/03 23:42:24 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.9 $
+# NetHack 3.7  Porting       $NHDT-Date: 1643491454 2022/01/29 21:24:14 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.17 $
 # Copyright (c) 2005 by Michael Allison
 # NetHack may be freely redistributed.  See license for details.
index 7267b12133178a5e08f306a9eb7daeea63e7f4ea..19574823a6eebefc363da6c3011b794c24ca876e 100644 (file)
@@ -2,7 +2,7 @@
 *.6    NHSUBST
 *.7    NHSUBST
 fixes* NHSUBST
-window.doc NHSUBST
+window.txt NHSUBST
 config.nh NHSUBST
 Guidebook.txt NH_header=no
 tmac.n NH_header=no
similarity index 100%
rename from doc/fixes10.0
rename to doc/fixes1-0-0.txt
similarity index 100%
rename from doc/fixes14.f
rename to doc/fixes1-4-f.txt
similarity index 100%
rename from doc/fixes22.0
rename to doc/fixes2-2-0.txt
similarity index 100%
rename from doc/fixes23.e
rename to doc/fixes2-3-e.txt
similarity index 100%
rename from doc/fixes30.0
rename to doc/fixes3-0-0.txt
similarity index 100%
rename from doc/fixes30.pl01
rename to doc/fixes3-0-pl01.txt
similarity index 100%
rename from doc/fixes30.pl02
rename to doc/fixes3-0-pl02.txt
similarity index 100%
rename from doc/fixes30.pl03
rename to doc/fixes3-0-pl03.txt
similarity index 100%
rename from doc/fixes30.pl04
rename to doc/fixes3-0-pl04.txt
similarity index 100%
rename from doc/fixes30.pl05
rename to doc/fixes3-0-pl05.txt
similarity index 100%
rename from doc/fixes30.pl06
rename to doc/fixes3-0-pl06.txt
similarity index 100%
rename from doc/fixes30.pl07
rename to doc/fixes3-0-pl07.txt
similarity index 100%
rename from doc/fixes30.pl08
rename to doc/fixes3-0-pl08.txt
similarity index 100%
rename from doc/fixes30.pl09
rename to doc/fixes3-0-pl09.txt
similarity index 100%
rename from doc/fixes30.pl10
rename to doc/fixes3-0-pl10.txt
similarity index 100%
rename from doc/fixes31.1
rename to doc/fixes3-1-1.txt
similarity index 100%
rename from doc/fixes31.2
rename to doc/fixes3-1-2.txt
similarity index 100%
rename from doc/fixes31.3
rename to doc/fixes3-1-3.txt
similarity index 100%
rename from doc/fixes32.0
rename to doc/fixes3-2-0.txt
similarity index 100%
rename from doc/fixes32.1
rename to doc/fixes3-2-1.txt
similarity index 100%
rename from doc/fixes32.2
rename to doc/fixes3-2-2.txt
similarity index 100%
rename from doc/fixes32.3
rename to doc/fixes3-2-3.txt
similarity index 100%
rename from doc/fixes33.0
rename to doc/fixes3-3-0.txt
similarity index 100%
rename from doc/fixes33.1
rename to doc/fixes3-3-1.txt
similarity index 100%
rename from doc/fixes34.0
rename to doc/fixes3-4-0.txt
similarity index 100%
rename from doc/fixes34.1
rename to doc/fixes3-4-1.txt
similarity index 100%
rename from doc/fixes34.2
rename to doc/fixes3-4-2.txt
similarity index 100%
rename from doc/fixes34.3
rename to doc/fixes3-4-3.txt
similarity index 100%
rename from doc/fixes35.0
rename to doc/fixes3-5-0.txt
similarity index 100%
rename from doc/fixes36.0
rename to doc/fixes3-6-0.txt
similarity index 100%
rename from doc/fixes36.1
rename to doc/fixes3-6-1.txt
similarity index 100%
rename from doc/fixes36.2
rename to doc/fixes3-6-2.txt
similarity index 100%
rename from doc/fixes36.3
rename to doc/fixes3-6-3.txt
similarity index 100%
rename from doc/fixes36.4
rename to doc/fixes3-6-4.txt
similarity index 100%
rename from doc/fixes36.5
rename to doc/fixes3-6-5.txt
similarity index 100%
rename from doc/fixes36.6
rename to doc/fixes3-6-6.txt
similarity index 99%
rename from doc/fixes37.0
rename to doc/fixes3-7-0.txt
index f4b5feae4e4e153b8609bb442327d63c646dc47e..507945cb763ba70e3419eb0923b85aa0368099c0 100644 (file)
@@ -1,4 +1,4 @@
-NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.734 $ $NHDT-Date: 1641673963 2022/01/08 20:32:43 $
+NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.0 $ $NHDT-Date: 1643491497 2022/01/29 21:24:57 $
 
 General Fixes and Modified Features
 -----------------------------------
@@ -1521,7 +1521,7 @@ options overhaul: moved the option definitions into include/optlist.h;
        combined the boolean and compound options into one allopt[] array;
        each option has its own individual function for setting the option,
        for retrieving the option value, and for processing the option
-       following its selection in the 'O' menu, added doc/options.doc file.
+       following its selection in the 'O' menu, added doc/options.txt file.
 function reglyph_darkroom() relocated from options.c to display.c
 resurrect 'makedefs -m' to be able to derive default mons[].diffculty values
        suitable for assigning to new or changed monsters
similarity index 100%
rename from doc/fixesXX.X
rename to doc/fixesX-X-X.txt
similarity index 100%
rename from doc/options.doc
rename to doc/options.txt
similarity index 99%
rename from doc/window.doc
rename to doc/window.txt
index ccc5a596bb1ec4246532bbdeeef46e0bb9e6c6d7..6e14c53cde4aa9bfc372bd2b4b3aad7f28e3bbb7 100644 (file)
@@ -1,4 +1,4 @@
-NetHack 3.7  window.doc        $NHDT-Date: 1615154657 2021/03/07 22:04:17 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.63 $
+NetHack 3.7  window.txt        $NHDT-Date: 1643491505 2022/01/29 21:25:05 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.0 $
 
 Introduction
 
index ba808dc4f55d0e37f6b10e29a8d9dd7fe6531f9e..b419909a0b9886f76be6a1242a123488faf4c89a 100644 (file)
@@ -6,7 +6,7 @@
 
 /*
  *  NOTE:  If you add (or delete) an option, please review:
- *             doc/options.doc
+ *             doc/options.txt
  *
  *         It contains how-to info and outlines some required/suggested
  *         updates that should accompany your change.
index f3b527888bc675b6055a9532c4f11f60948cdeed..82efa3d425caec83cf241b8656e02bb886ea1c04 100644 (file)
@@ -1,9 +1,9 @@
-/* NetHack 3.7 winX.h  $NHDT-Date: 1613272633 2021/02/14 03:17:13 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.45 $ */
+/* NetHack 3.7 winX.h  $NHDT-Date: 1643491525 2022/01/29 21:25:25 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.52 $ */
 /* Copyright (c) Dean Luick, 1992                                 */
 /* NetHack may be freely redistributed.  See license for details. */
 
 /*
- * Definitions for the X11 window-port.  See doc/window.doc for details on
+ * Definitions for the X11 window-port.  See doc/window.txt for details on
  * the window interface.
  */
 #ifndef WINX_H
index 75393728931375c8f21104c05d0029c6f2aafc35..c6820470308831b79e1775ebe39fb34ed548a7b5 100644 (file)
@@ -1,4 +1,4 @@
-/* NetHack 3.7 display.c       $NHDT-Date: 1638622699 2021/12/04 12:58:19 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.165 $ */
+/* NetHack 3.7 display.c       $NHDT-Date: 1643491545 2022/01/29 21:25:45 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.174 $ */
 /* Copyright (c) Dean Luick, with acknowledgements to Kevin Darcy */
 /* and Dave Cohrs, 1990.                                          */
 /* NetHack may be freely redistributed.  See license for details. */
@@ -15,7 +15,7 @@
  * what to draw at a given location.  The routines for the vision system
  * can be found in vision.c and vision.h.  The routines for display can
  * be found in this file (display.c) and display.h.  The drawing routines
- * are part of the window port.  See doc/window.doc for the drawing
+ * are part of the window port.  See doc/window.txt for the drawing
  * interface.
  *
  * The display system deals with an abstraction called a glyph.  Anything
index 10011f6656178ecdcb5d276a04bff3b06e951418..c66379903c199a9c6dbf70695b0e3860af022b94 100644 (file)
@@ -1,4 +1,4 @@
-/* NetHack 3.7 options.c       $NHDT-Date: 1642630919 2022/01/19 22:21:59 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.528 $ */
+/* NetHack 3.7 options.c       $NHDT-Date: 1643491546 2022/01/29 21:25:46 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.535 $ */
 /* Copyright (c) Stichting Mathematisch Centrum, Amsterdam, 1985. */
 /*-Copyright (c) Michael Allison, 2008. */
 /* NetHack may be freely redistributed.  See license for details. */
@@ -20,7 +20,7 @@ NEARDATA struct instance_flags iflags; /* provide linkage */
 
 /*
  *  NOTE:  If you add (or delete) an option, please review the following:
- *             doc/options.doc
+ *             doc/options.txt
  *
  *         It contains how-to info and outlines some required/suggested
  *         updates that should accompany your change.
index 062f1e605d24bce5e2e83eae20eb9f1132e420d6..4458cbab03134f7bc940a7704ea96ba910e868e8 100644 (file)
@@ -39,10 +39,10 @@ WASM also has a npm module that can be published out of `sys/lib/npm-library`. A
 The API is two functions:
 * `nhmain(int argc, char *argv[])` - The main function for NetHack that configures the program and runs the `moveloop()` until the game is over. The arguments to this function are the [command line arguments](https://nethackwiki.com/wiki/Options) to NetHack.
 * `shim_graphics_set_callback(shim_callback_t cb)` - A single function that sets a callback to gather graphics events: write a string to screen, get user input, etc. Your job is to pass in a callback and handle all the requested rendering events to show NetHack on the scrren. The callback is `void shim_callback_t(const char *name, void *ret_ptr, const char *fmt,  ...)`
-  * `name` is the name of the [window function](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.doc) that needs to be handled
+  * `name` is the name of the [window function](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.txt) that needs to be handled
   * `ret_ptr` is a pointer to a memory space for the return value. The type expected to be returned in this pointer is described by the first character of the `fmt` string.
   * `fmt` is a string that describes the signature of the callback. The first character in the string is the return type and any additional characters describe the variable arguments: `i` for integer, `s` for string, `p` for pointer, `c` for character, `v` for void. For example, if format is "vis" the callback will have no return (void), the first argument will be an integer, and the second argument will be a string. If format is "iii" the callback must return an integer, and both the arguments passed in will be integers.
-  * [Variadic arguments](https://www.gnu.org/software/libc/manual/html_node/Variadic-Example.html): a variable number and type of arguments depending on the `window function` that is being called. The arguments associated with each `name` are described in the [NetHack window.doc](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.doc).
+  * [Variadic arguments](https://www.gnu.org/software/libc/manual/html_node/Variadic-Example.html): a variable number and type of arguments depending on the `window function` that is being called. The arguments associated with each `name` are described in the [NetHack window.txt](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.txt).
 
 Where is the header file for the API you ask? There isn't one. It's three functions, just drop the forward declarations at the top of your file (or create your own header). It's more work figuring out how to install and copy around header files than it's worth for such a small API. If you disagree, feel free to sumbit a PR to fix it. :)
 
@@ -50,8 +50,8 @@ Where is the header file for the API you ask? There isn't one. It's three functi
 The WebAssembly API has a similar signature to `libnethack.a` with minor syntactic differences:
 * `main(int argc, char argv[])` - The main function for NetHack
 * `shim_graphics_set_callback(char *cbName)` - A `String` representing a name of a callback function. The callback function be registered as `globalThis[cbName] = function yourCallback(name, ... args) { /* your stuff */ }`. Note that [globalThis](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis) points to `window` in browsers and `global` in node.js.
-  * `name` is the name of the [window function](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.doc) that needs to be handled
-  * `... args` is a variable number and type of arguments depending on the `window function` that is being called. The arguments associated with each `name` are described in the [NetHack window.doc](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.doc)
+  * `name` is the name of the [window function](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.txt) that needs to be handled
+  * `... args` is a variable number and type of arguments depending on the `window function` that is being called. The arguments associated with each `name` are described in the [NetHack window.txt](https://github.com/NetHack/NetHack/blob/NetHack-3.7/doc/window.txt)
   * The function must return the value expected for the specified `name`
 
 
index 0221e827175a81c9c734f40512c07f4ab8aa4ba4..6a0a20705ab211d89666965a88dd4bafb6c806a2 100644 (file)
@@ -1,10 +1,10 @@
-/* NetHack 3.7 winX.c  $NHDT-Date: 1643328675 2022/01/28 00:11:15 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.109 $ */
+/* NetHack 3.7 winX.c  $NHDT-Date: 1643491577 2022/01/29 21:26:17 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.110 $ */
 /* Copyright (c) Dean Luick, 1992                                 */
 /* NetHack may be freely redistributed.  See license for details. */
 
 /*
  * "Main" file for the X window-port.  This contains most of the interface
- * routines.  Please see doc/window.doc for an description of the window
+ * routines.  Please see doc/window.txt for an description of the window
  * interface.
  */
 
index c754d75eeac947cf08a653068cc3146f9b6c7e38..2631ae863d22b9268cd8c140aeabe6f80dd63feb 100644 (file)
@@ -131,7 +131,7 @@ curses_status_finish(void)
  *         Each condition bit must only ever appear in one of the
  *         CLR_ array members, but can appear in multiple HL_ATTCLR_
  *         offsets (because more than one attribute can co-exist).
- *         See doc/window.doc for more details.
+ *         See doc/window.txt for more details.
  */
 
 static int changed_fields = 0;
index e6c353ce93f5f15f5e33736260d293844f63526b..8d1a77495bcd422993384984844c5151f6385eb1 100644 (file)
@@ -1,4 +1,4 @@
-/* NetHack 3.7 wintty.c        $NHDT-Date: 1608861214 2020/12/25 01:53:34 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.264 $ */
+/* NetHack 3.7 wintty.c        $NHDT-Date: 1643491577 2022/01/29 21:26:17 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.282 $ */
 /* Copyright (c) David Cohrs, 1991                                */
 /* NetHack may be freely redistributed.  See license for details. */
 
@@ -3874,7 +3874,7 @@ tty_status_enablefield(int fieldidx, const char *nm, const char *fmt,
  *         Each condition bit must only ever appear in one of the
  *         CLR_ array members, but can appear in multiple HL_ATTCLR_
  *         offsets (because more than one attribute can co-exist).
- *         See doc/window.doc for more details.
+ *         See doc/window.txt for more details.
  */
 
 DISABLE_WARNING_FORMAT_NONLITERAL