Viewing Issue Simple Details Jump to Notes ] Wiki ] View Advanced ] Issue History ] Print ]
ID Category Severity Reproducibility Date Submitted Last Update
0004335 [DCSS] Bug Report minor always 2011-07-29 11:58 2011-08-11 03:37
Reporter zespri View Status public  
Assigned To KiloByte
Priority normal Resolution done  
Status resolved   Product Branch 0.10 ancient branch
Summary 0004335: shortcuts to manual sections not working
Description makefile uses wget for getting the latest version of crawl_manual.reST Win32 build instruction explains the msysgit requirement, however msysgit does not come with wget by default. Because of this retrieving crawl_manual.reST from web fails.

Required files from MSYS:
msys-crypto-1.0.0.dll
msys-iconv-2.dll
msys-intl-8.dll
msys-ssl-1.0.0.dll
wget.exe

In addition wgetrc needs to be put to
msysgit\etc\

It must contain
check_certificate = off
otherwise wget command will fail over https since msys wget does not know where to get CA certs.

In additions, there is one more weird thing that I can't quite explain. When you run just 'make', on Linux the 'rest' target gets executed among all other and up to date crawl_manual.reST gets fetched. On Win32 though, when you run just 'make' the 'rest' target is NOT executed and crawl_manual.reST that comes from git gets built. In the version that this issue is reported for the file (crawl_manual.reST) in git does not get processed correctly by unrest.pl and as a result it is not possible to use commands ?A through to ?N in-game.
Additional Information
Tags No tags attached.
Attached Files txt file icon crawl_manual.txt [^] (137,278 bytes) 2011-08-10 22:01

- Relationships

-  Notes
(0014108)
KiloByte (manager)
2011-08-08 23:44

Not a bug, wget is never needed during build.

I don't get where you took the impression that the "rest" target is ever used automatically. Even, unlike rebuilding of yaccage, it's never present on the right-hand side of any rule.

Other requirements not mentioned are yacc+lex for when you edit the level compiler, the whole of TeX and docutils if you want a PDF, a cross compiler needed to build Windows packages on non-Windows systems, zip for Windows zipballs, nsis for the Windows installer and so on.

But unlike nsis which you might want for unofficial builds, there is never a reason to run "make rest" yourself since it is useless except for the official wiki.
(0014135)
zespri (reporter)
2011-08-10 12:51

How does crawl_manual.txt get built then? It's not in git.
(0014136)
zespri (reporter)
2011-08-10 12:59

So here is how I understand it. Please correct me where I'm wrong.

- You are absolutely correct, that the rest target in never used automatically
- However building crawl_manual.txt from crawl_manual.reST does happen automatically
- Currently in git there are apparently botched version of crawl_manual.reST that produces invalid crawl_manual.txt when run through util/unrest.pl
- As a result it is not possible to use commands ?A through to ?N in-game.
(0014137)
zespri (reporter)
2011-08-10 13:03

I'm sorry for trying to reopen it, I'm doing this because I think these comments won't get noticed unless I re-open. Please let me know if this is not the case. In addition, please feel free to close it again if you still feel, that the behaviour is correct, i.e. that users are not supposed to use ?A - ?N command in game to quickly skip to particular manual chapters.
(0014138)
zespri (reporter)
2011-08-10 13:21

Please see my comments. Thanks.
(0014139)
KiloByte (manager)
2011-08-10 13:28

You don't need wget to convert crawl_manual.reST to crawl_manual.txt, albeit you do need perl.

Could you tell me what is the problem with ?A - ?N that you see? It seems to work for me, on Debian, Windows XP, Windows 7 and Mac. Can't try tiles right now.
(0014144)
zespri (reporter)
2011-08-10 22:01

Yep, when you press ?A - ?N no help is shown. Instead the game returns back to the main game screen.

crawl_manual.txt that is built looks distinctly different from the one that comes in official release. I'm attaching a copy.
(0014145)
zespri (reporter)
2011-08-10 22:06

I do understand that you don't need wget to convert crawl_manual.reST to crawl_manual.txt, albeit you do need perl. The current issue title is no longer relevant, but I did not know that when I was reporting it.

The thing is, if I use wget to get a fresh crawl_manual.reST from the wiki, the crawl_manual.txt that is produced is fine, and ?A - ?N work. But on Windows 7 if wget is not used the crawl_manual.txt id produced as attached. And this breaks ?A - ?N.

Can you replace your crawl_manual.txt with the one that I've attached and see if you can reproduce ?A - ?N not working?
(0014146)
KiloByte (manager)
2011-08-10 22:26

Found the cause.
The manual viewer gets confused by MS-DOS newlines.

Fixed.
(0014151)
zespri (reporter)
2011-08-11 03:37

Yep, this has fixed it. Thank you for you time and attention.

- Issue History
Date Modified Username Field Change
2011-07-29 11:58 zespri New Issue
2011-07-29 11:59 zespri Issue Monitored: zespri
2011-08-08 23:44 KiloByte Note Added: 0014108
2011-08-08 23:44 KiloByte Status new => resolved
2011-08-08 23:44 KiloByte Fixed in Branch => 0.9 development branch
2011-08-08 23:44 KiloByte Resolution open => no change required
2011-08-08 23:44 KiloByte Assigned To => KiloByte
2011-08-10 12:51 zespri Note Added: 0014135
2011-08-10 12:59 zespri Note Added: 0014136
2011-08-10 13:03 zespri Note Added: 0014137
2011-08-10 13:21 zespri Note Added: 0014138
2011-08-10 13:21 zespri Status resolved => feedback
2011-08-10 13:21 zespri Resolution no change required => reopened
2011-08-10 13:28 KiloByte Note Added: 0014139
2011-08-10 22:01 zespri Note Added: 0014144
2011-08-10 22:01 zespri File Added: crawl_manual.txt
2011-08-10 22:06 zespri Note Added: 0014145
2011-08-10 22:23 KiloByte Severity text => minor
2011-08-10 22:23 KiloByte Category Documentation => Bug Report
2011-08-10 22:23 KiloByte Summary Wget requirement is not mentioned in documentation => shortcuts to manual sections not working
2011-08-10 22:26 KiloByte Note Added: 0014146
2011-08-10 22:26 KiloByte Status feedback => resolved
2011-08-10 22:26 KiloByte Resolution reopened => done
2011-08-11 03:37 zespri Note Added: 0014151


Mantis 1.1.8[^]
Copyright © 2000 - 2009 Mantis Group
Powered by Mantis Bugtracker