Update docs, man page.
Add last chance attempt to build dat/gitinfo.txt
This commit is contained in:
+18
-11
@@ -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.
|
Welcome to the NetHack Infrastructure Developer's Guide.
|
||||||
|
|
||||||
@@ -25,7 +25,7 @@ CONTENTS
|
|||||||
5. variable expansion
|
5. variable expansion
|
||||||
6. reserved names
|
6. reserved names
|
||||||
7. nhadd/nhcommit
|
7. nhadd/nhcommit
|
||||||
8. DEVEL hooks
|
8. hooks
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
1. email
|
1. email
|
||||||
Email to devteam@nethack.org will usually get a response, but it may take a
|
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
|
or
|
||||||
https://sourceforge.net/p/nethack/NetHack/
|
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
|
3. bug reporting
|
||||||
Please use the form at http://www.nethack.org/common/contact.html (or send
|
Please use the form at http://www.nethack.org/common/contact.html (or send
|
||||||
@@ -96,7 +97,8 @@ C. Configure the repository:
|
|||||||
-v verbose
|
-v verbose
|
||||||
-n dry run
|
-n dry run
|
||||||
You can re-run nhgitset.pl as often as needed; occasionally we will
|
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
|
D. aliases
|
||||||
Two aliases are installed by nhgitset.pl:
|
Two aliases are installed by nhgitset.pl:
|
||||||
nhadd
|
nhadd
|
||||||
@@ -213,14 +215,19 @@ D. Using your own hooks
|
|||||||
"perldoc DEVEL/hooksdir/nhsub".
|
"perldoc DEVEL/hooksdir/nhsub".
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
8. DEVEL hooks
|
8. hooks
|
||||||
|
|
||||||
If you copy DEVEL/hooksdir/* into .git/hooks, you'll benefit from
|
nhgitset.pl also installs hooks into .git/hooks. These hooks provide
|
||||||
having a new dat/gitinfo.txt created for several common git operations
|
a framework which allows local hook code to co-exist with hook code we
|
||||||
that are likely to result in a new git sha. During the nethack build
|
supply - see DEVEL/hooksdir/NHgithook.pm for details.
|
||||||
process, makedefs will transform the values contained in
|
|
||||||
dat/gitinfo.txt into #define's in include/date.h which the NetHack
|
We currently use the following hooks:
|
||||||
source will utilize.
|
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.
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
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:
|
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
|
A public repository of the latest NetHack code that we've made
|
||||||
available can be obtained via git here:
|
available can be obtained via git here:
|
||||||
|
|||||||
+4
-4
@@ -1,5 +1,5 @@
|
|||||||
.TH NETHACK 6 "7 December 2015"
|
.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
|
.SH NAME
|
||||||
nethack \- Exploring The Mazes of Menace
|
nethack \- Exploring The Mazes of Menace
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
@@ -34,6 +34,9 @@ nethack \- Exploring The Mazes of Menace
|
|||||||
[
|
[
|
||||||
.B \-ibm
|
.B \-ibm
|
||||||
]
|
]
|
||||||
|
[
|
||||||
|
.BR \-\-version [ :paste ]
|
||||||
|
]
|
||||||
.PP
|
.PP
|
||||||
.B nethack
|
.B nethack
|
||||||
[
|
[
|
||||||
@@ -55,9 +58,6 @@ nethack \- Exploring The Mazes of Menace
|
|||||||
[
|
[
|
||||||
.I playernames
|
.I playernames
|
||||||
]
|
]
|
||||||
[
|
|
||||||
.B \-\-version
|
|
||||||
]
|
|
||||||
.ad
|
.ad
|
||||||
.hy 14
|
.hy 14
|
||||||
.\" Make sure path is not hyphenated below
|
.\" Make sure path is not hyphenated below
|
||||||
|
|||||||
+1
-1
@@ -7,7 +7,7 @@ NAME
|
|||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
nethack [ -d directory ] [ -n ] [ -p profession ] [ -r race ] [ -[DX] ]
|
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 ] [
|
nethack [ -d directory ] -s [ -v ] [ -p profession ] [ -r race ] [
|
||||||
playernames ]
|
playernames ]
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# NetHack Makefile.
|
# 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:
|
# Root of source tree:
|
||||||
NHSROOT=..
|
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
|
# hack.h depends on makedefs' output, so we know makedefs will be
|
||||||
# up to date before being executed
|
# up to date before being executed
|
||||||
../include/date.h: $(VERSOURCES) $(HACK_H)
|
../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
|
../util/makedefs -v
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user