options: description
Steve, list, This may be a better description of --description, it sort of warns for the description that splitter puts in the args file. Best regards, Valentijn -- Durgerdamstraat 29, 1507 JL Zaandam; telefoon 075-7074579
Valentijn, Steve, list, On Tue, Aug 25, 2009 at 07:42:59AM +0200, Valentijn Sessink wrote:
This may be a better description of --description, it sort of warns for the description that splitter puts in the args file.
Index: resources/help/en/options =================================================================== --- resources/help/en/options (revision 1144) +++ resources/help/en/options (working copy) @@ -36,7 +36,12 @@
--description=text Sets the descriptive text for the map. This may be displayed in - QLandkarte, MapSource on on a GPS etc. + QLandkarte, MapSource on on a GPS etc, where it is normally shown + below the family name. Example: --description="Germany, Denmark"
"on on" should be "or on"
+ Please note: if you use splitter.jar to build a template.args file + and use -c template.args, then that file may contain a + "description" that will override this option. Use "--description" in + splitter.jar to change the description in the template.args file.
I think that this is a general remark that would better be documented with the -c option, something like this: -c filename --read-config=filename The given file is opened and each line is an option setting of the form option=value, any option that could be used on the command line can be used, however you omit the leading '--'. The short option names with a single '-' cannot be used, simply use the long name instead. + Note: mkgmap will process options from left to right. Options given + in the command line after "-c filename" will override any options + given in the file. Likewise, command line options specified before + "-c filename" will be overridden by the option file. Please feel free to improve the wording. I wouldn't mention splitter.jar in the help text, because the config file may be edited by hand. Best regards, Marko
Hi all, Marko Mäkelä schreef:
"on on" should be "or on"
Fixed (see attachment)
+ Please note: if you use splitter.jar to build a template.args file + and use -c template.args, then that file may contain a [...] I think that this is a general remark that would better be documented with the -c option, something like this:
I think your explanation to the -c is very useful, too.
Please feel free to improve the wording. I wouldn't mention splitter.jar in the help text, because the config file may be edited by hand.
I agree. However, the "--description" not working gave me headaches, that's why I mentioned it at the --description description. Revised (and combined) patch attached. Better? Valentijn
Hi Valentijn,
I agree. However, the "--description" not working gave me headaches, that's why I mentioned it at the --description description.
OK, I hope that it is a correct balance. Make the help text too verbose, and people won't read it. Make it too terse, and people won't understand it.
Revised (and combined) patch attached. Better?
Yes, except for one thing:
--description=text Sets the descriptive text for the map. This may be displayed in - QLandkarte, MapSource on on a GPS etc. + QLandkarte, MapSource or on a GPS etc, where it is normally shown + below the family name. Example: --description="Germany, Denmark" + Please note: if you use "-c template.args", then that file may + contain a "description" that will override this option.
I would say "-c filename" instead of "-c template.args", so that it will be possible to search for that string. And instead of "will override" I would say "may override". It boils down to the contents of the -c file, and you may write "-c filename --description=text" as well. Marko
Marko Mäkelä schreef:
+ Please note: if you use "-c template.args", then that file may + contain a "description" that will override this option. I would say "-c filename" instead of "-c template.args", so that it will be possible to search for that string. And instead of "will override" I would say "may override". It boils down to the contents of the -c file, and you may write "-c filename --description=text" as well.
I'm not sure about the "-c filename". The only reason for mentioning the "-c" option here is that splitter writes a file with the name "template.args". Anyone who uses their own template file will probably know what they're doing anyway. It is the specific use of the *splitter-produced* file (that goes by the name of template.args) that is the culprit. But I do understand what you are saying. Does anyone else have an opinion about this? V.
Steve Ratcliffe schreef:
Perhaps it belongs in the splitter doc then? Or the splitter could leave out (or comment out) the description lines by default, unless the --description option is given.
I agree. Although then still a remark about the -c filename "description" could be useful. (As you see, I dropped the referral to splitter already). V.
Steve Ratcliffe schreef:
Perhaps it belongs in the splitter doc then? Or the splitter could leave out (or comment out) the description lines by default, unless the --description option is given.
Like in the attached patch? (Usual disclaimers apply: I'm not a programmer, I don't know Java, batteries not included). If you think this patch is ready for committing, then you might want to commit the attached documentation patch for mkgmap as well (credits mainly to Marko Mäkelä for this one). Best regards, Valentijn
participants (3)
-
Marko Mäkelä -
Steve Ratcliffe -
Valentijn Sessink