From cd96394ccd447a4d58dde6e0ef6f21ec357bf1c9 Mon Sep 17 00:00:00 2001 From: keni Date: Wed, 21 Feb 2018 10:58:31 -0500 Subject: [PATCH] Update docs, man page. Add last chance attempt to build dat/gitinfo.txt --- DEVEL/Developer.txt | 29 ++++++++++++++++++----------- README | 5 ++++- doc/nethack.6 | 8 ++++---- doc/nethack.txt | 2 +- sys/unix/Makefile.src | 5 ++++- 5 files changed, 31 insertions(+), 18 deletions(-) diff --git a/DEVEL/Developer.txt b/DEVEL/Developer.txt index b896e707a..e9b943499 100644 --- a/DEVEL/Developer.txt +++ b/DEVEL/Developer.txt @@ -4,7 +4,7 @@ |___/\___|\_/\___|_\___/ .__/\___|_| |_| -$NHDT-Date: 1518800857 2018/02/16 17:07:37 $ +$NHDT-Date: 1519228647 2018/02/21 15:57:27 $ Welcome to the NetHack Infrastructure Developer's Guide. @@ -25,7 +25,7 @@ CONTENTS 5. variable expansion 6. reserved names 7. nhadd/nhcommit -8. DEVEL hooks +8. hooks ------------------------------------------------------------------------------ 1. email Email to devteam@nethack.org will usually get a response, but it may take a @@ -39,7 +39,8 @@ available can be obtained via git from either of two locations: or https://sourceforge.net/p/nethack/NetHack/ -XXX need to discuss what branches are available +Branches: +NetHack-3.6.0 The 3.6.0 release code and subsequent fixes and additions. ------------------------------------------------------------------------------ 3. bug reporting Please use the form at http://www.nethack.org/common/contact.html (or send @@ -96,7 +97,8 @@ C. Configure the repository: -v verbose -n dry run You can re-run nhgitset.pl as often as needed; occasionally we will - update it and ask you to run it again. + update it (or something it installs) and you will need to run it again + so the changes take effect. D. aliases Two aliases are installed by nhgitset.pl: nhadd @@ -213,14 +215,19 @@ D. Using your own hooks "perldoc DEVEL/hooksdir/nhsub". ------------------------------------------------------------------------------ -8. DEVEL hooks +8. hooks - If you copy DEVEL/hooksdir/* into .git/hooks, you'll benefit from - having a new dat/gitinfo.txt created for several common git operations - that are likely to result in a new git sha. During the nethack build - process, makedefs will transform the values contained in - dat/gitinfo.txt into #define's in include/date.h which the NetHack - source will utilize. + nhgitset.pl also installs hooks into .git/hooks. These hooks provide + a framework which allows local hook code to co-exist with hook code we + supply - see DEVEL/hooksdir/NHgithook.pm for details. + + We currently use the following hooks: + post-checkout + post-commit + post-merge + These are used to generate dat/gitinfo.txt which provides the data that + ends up available through the game command #version and the command line + option --version. ------------------------------------------------------------------------------ diff --git a/README b/README index 5c4117f46..c428e146d 100644 --- a/README +++ b/README @@ -122,7 +122,10 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code. If you have problems building the game, or you find bugs in it, we recommend filing a bug report from our "Contact Us" web page at: - http://www.nethack.org/ + https://www.nethack.org/common/contact.html or + http://www.nethack.org/common/contact.html +Please include the version information from #version or the command line +option --version in the apropriate field. A public repository of the latest NetHack code that we've made available can be obtained via git here: diff --git a/doc/nethack.6 b/doc/nethack.6 index 6b38a68ba..f2ef799f1 100644 --- a/doc/nethack.6 +++ b/doc/nethack.6 @@ -1,5 +1,5 @@ .TH NETHACK 6 "7 December 2015" -.\" NetHack 3.6 nethack.6 $NHDT-Date: 1449616496 2015/12/08 23:14:56 $ $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.11 $ +.\" NetHack 3.6 nethack.6 $NHDT-Date: 1519228609 2018/02/21 15:56:49 $ $NHDT-Branch: githash $:$NHDT-Revision: 1.13 $ .SH NAME nethack \- Exploring The Mazes of Menace .SH SYNOPSIS @@ -34,6 +34,9 @@ nethack \- Exploring The Mazes of Menace [ .B \-ibm ] +[ +.BR \-\-version [ :paste ] +] .PP .B nethack [ @@ -55,9 +58,6 @@ nethack \- Exploring The Mazes of Menace [ .I playernames ] -[ -.B \-\-version -] .ad .hy 14 .\" Make sure path is not hyphenated below diff --git a/doc/nethack.txt b/doc/nethack.txt index 9e6275edf..4c9986349 100644 --- a/doc/nethack.txt +++ b/doc/nethack.txt @@ -7,7 +7,7 @@ NAME SYNOPSIS nethack [ -d directory ] [ -n ] [ -p profession ] [ -r race ] [ -[DX] ] - [ -u playername ] [ -dec ] [ -ibm ] + [ -u playername ] [ -dec ] [ -ibm ] [ --version[:paste] ] nethack [ -d directory ] -s [ -v ] [ -p profession ] [ -r race ] [ playernames ] diff --git a/sys/unix/Makefile.src b/sys/unix/Makefile.src index 451067a93..19f41ca81 100644 --- a/sys/unix/Makefile.src +++ b/sys/unix/Makefile.src @@ -1,5 +1,5 @@ # NetHack Makefile. -# NetHack 3.6 Makefile.src $NHDT-Date: 1459122529 2016/03/27 23:48:49 $ $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.46 $ +# NetHack 3.6 Makefile.src $NHDT-Date: 1519228664 2018/02/21 15:57:44 $ $NHDT-Branch: githash $:$NHDT-Revision: 1.51 $ # Root of source tree: NHSROOT=.. @@ -610,6 +610,9 @@ tile.c: ../win/share/tilemap.c $(HACK_H) # hack.h depends on makedefs' output, so we know makedefs will be # up to date before being executed ../include/date.h: $(VERSOURCES) $(HACK_H) + if [[ ! -f ../dat/gitinfo.txt ]]; then \ + (cd ..;perl -IDEVEL/hooksdir -MNHgithook -e '&NHgithook::nhversioning') || true; \ + fi ../util/makedefs -v