[mkgmap-dev] documentation improvement patch

Thu Jan 30 12:47:48 GMT 2020

Hi Gerd, no issues with those changes. I think I also inadvertently lost a
blank line immediately before === Mkgmap options ===.

However, I think it is illogical to use stderr to display the version. I was
considering following up with a small patch to change the version output
from stderr and stop the program exiting after outputting the version. It
seems illogical to exit if --version is anywhere on the command line
regardless of the other options, and the documentation doesn't say it does
this (the splitter documentation does). I'm off on holiday shortly, so
probably won't be sending anything else for a while.

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:gpetermann_muenchen at hotmail.com] 
Sent: 30 January 2020 09:30
To: mkgmap-dev at lists.mkgmap.org.uk
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

if I got that right you didn't compile help\options before you created
doc-v7.patch.
I also have some problems checking your patch because you changed the line
endings to windows style (0d0a) instead of unix(0a)
I've attached two patches:
doc-v7-unix.patch:
used your patch with line endings converted to unix and create a new patch.
This is much smaller. 
doc-v8.patch:
- two small changes in options.txt
 + --version writs to stderr, this information is considered important, see
http://www.mkgmap.org.uk/websvn/revision.php?repname=mkgmap&rev=2642
 + addedd missing "when" 
- freshly compiled help\options

If you agree with  these small changes I'll commit the v8.
doc-v7-unix.patch
<http://gis.19327.n8.nabble.com/file/t318326/doc-v7-unix.patch>  
doc-v8.patch <http://gis.19327.n8.nabble.com/file/t318326/doc-v8.patch>  

Mike Baggaley wrote
> Hi Gerd,
> 
> It appears that mkgmap can only display ASCII characters, so although
> non-ASCII characters are copied faithfully from options.txt to options,
> mkgmap cannot display them. I have added an ASCII test to the code which
> displays the line number and offending text, - it transpires there was a
> non
> ASCII letter in the example usage of --mdr7-excl=name plus three special
> hyphens.
> 
> For the long lines, I hadn't handled the case where adding two lines
> together exceeded 160 characters and hence needed chopping twice. Now
> fixed.
> 
> I did wonder about taking out the example file. I have removed this from
> options.txt and put it in a new file logging.txt and referenced it from
> index.txt. I've also put it in a logging file for display from the command
> line with help=logging. It may still look like a stack trace there, but
> should at least be more expected. I have added a bit more information and
> a
> reference to the Java documentation on logging at the end (primarily so
> you
> can see something after the 'stacktrace').
> 
> How does that seem?
> Mike
> doc-v7.patch (200K)
> <http://gis.19327.n8.nabble.com/attachment/5956414/0/doc-v7.patch>

--
Sent from: http://gis.19327.n8.nabble.com/Mkgmap-Development-f5324443.html