summaryrefslogtreecommitdiffstats
path: root/Documentation/howto-usage-function.txt
Commit message (Collapse)AuthorAgeFilesLines
* Docs: update howto-usage-function.txtJ William Piggott2017-07-311-15/+15
| | | | Signed-off-by: J William Piggott <elseifthen@gmx.com>
* Docs: move option naming to howto-contribute.txtJ William Piggott2017-06-241-28/+0Star
| | | | | | | | | Creating and naming options is not done when writing usage(). A contributor may not even read howto-usage-function.txt, but they should read howto-contribute.txt. So move option naming and change information there. Signed-off-by: J William Piggott <elseifthen@gmx.com>
* Docs: update howto-usage-function.txtJ William Piggott2017-06-241-36/+39
| | | | Signed-off-by: J William Piggott <elseifthen@gmx.com>
* docs: add program-desc to howto-usage-function.txt and boilerplate.cKarel Zak2017-06-211-0/+2
| | | | Signed-off-by: Karel Zak <kzak@redhat.com>
* Docs: update howto-usage-function.txtJ William Piggott2017-06-211-5/+7
| | | | Signed-off-by: J William Piggott <elseifthen@gmx.com>
* docs: optinal option arguments should be long-onlySami Kerola2016-04-171-1/+1
| | | | | | | | | | | Deprecate adding new short optional option arguments. They are problematic. Proposed-by: Ruediger Meier <sweet_f_a@gmx.de> Acked-by: Karel Zak <kzak@redhat.com> Reviewed-by: Benno Schulenberg <bensberg@justemail.net> Reference: https://lists.gnu.org/archive/html/coreutils/2012-11/msg00004.html Reference: http://marc.info/?l=util-linux-ng&m=146062997618853&w=2 Signed-off-by: Sami Kerola <kerolasa@iki.fi>
* docs: grammarize the usage howtoBenno Schulenberg2014-05-061-80/+78Star
| | | | Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
* docs: arch is gone, use delpart as usage() function exampleSami Kerola2013-03-261-1/+1
| | | | | | The arch.c was removed in commit 27abd809. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
* docs: usage function and gettextSami Kerola2013-01-251-3/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I made following survey which was sent to all email addresses in po/ directory that had the on-going millenium as time when translator had been active. There are two quite common styles to write a command usage print out, which one you prefer? 1. Each option as separated translatable string. 18 votes 2. Or the whole thing as one big output. 1 vote 3. No preference. 1 vote The questionaire had also free text field asking 'Why do you prefer that?', and here are the answers. [Separately] It is easier to follow changes with the translations. If you change only one line or two, the big string would change to fuzzy and I have to check the whole thing to see what was changed in the original. If the changed line is a single string, the string to check is a lot shorter. [No preference] Usually, if there is no reason to separate strings, better keep them together so that the context is obvious. In the case at hand, it might help if in some language e.g. one translated line is too wide for the screen. This is unlikely, but... OTOH, with this solution, if you change one string the whole translation will be discarded until a translator comes and updates it... [Separately] It may be a bit harder to get the formatting right, but it is much easier in maintenance. With one option changing, the translator immediately sees the spot. And even with a lazy translator, program author will have all the options translated that have not changed at all. [Separately] First one would be more in elegant I believe [Separately] I prefer to have them separately because they don't form a single text paragraph. In other words, they can be translated separately because they are complete and separate "sentences". Of course consistency of format and word choices need to be taken care of, but the fact that the messages appear next to each other in the PO file should be enough. Also if the options are not translated separately, adding or editing one option causes the translation of all options to become fuzzy and if for some reason it isn't checked before next release (happens sometimes), all of them will show untranslated to the user. [Separately] Translations are a lot easier to update that way. If an option is added, removed or changed, only a small amount of text becomes fuzzy. If everything is in one big output, a lot of text becomes fuzzy, and you have to read a lot more text to discover what exactly changed. [Separately] When updating a fuzzy translation, with one big output it's very tedious and error-prone to find out the reason for fuzziness, i.e. what actually has changed in the msgid. [Separately] Way easier to translate, and especially to spot translation updates when one string gets removed, added or modified. [Separately] Makes translation memory more efficient. Some hard terms in the list don't prevent translation of the whole block. Actually the beginning of the strings don't need any translation ta all before [] part. Information about the context can be provided in comments or the context parameter. [Separately] Please consider the case when a part of string, (= msgid) is changed. It is marked as fuzzy in the .po files, we translators have to check whole sentences for the difference between it and previous version. [Separately] Every sentence must be a separate translation unit. [One big output] for performance to ouput strings [Separately] In the second case, if only one option changes (or a new one is added), the translator will see as if all of the options changed, having to find out which one of them is really new or has actually changed. Also, if the translator has had no time to update the string, only one of the options will be shown in the original language (which is arguably ugly, but better than nothing for many users). [Separately] It's easier to translate the options separately using translation memory. [Separately] Easier to separate and see changes [Separately] more translator friendly [Separately] From the user POV I found the separeted version more interesting because if a maintainer can't update the translation fast enough between releases the user will still get the current translated string with the new ones untraslated. From the translator POV the big output will give more context information as one can see the whole command options. With a new string added while the rest is translated having some context can be more difficult. [Separately] Additions to the list or changes to one options means you don't have to check all lines each time. So unless you have very, _very_ good reason you should not output all usage as one big table. This implies also that when large usage output is changed it should be split to small hunks. That may be a bit more work once, but the next change will pay the extrawork off so never hesitate when splitting. Reference: http://www.surveymonkey.com/s/QKZ75HK Signed-off-by: Sami Kerola <kerolasa@iki.fi>
* ddate: remove from util-linuxSami Kerola2012-10-151-1/+1
| | | | | | | | | | | See RedHat bug for reasons why the ddate is cleaned up. The reference is where to get the command in future. Addresses: https://bugzilla.redhat.com/show_bug.cgi?id=823156 References: https://github.com/bo0ts/ddate Acked-by: Petr Uzel <petr.uzel@suse.cz> Signed-off-by: Sami Kerola <kerolasa@iki.fi> Signed-off-by: Karel Zak <kzak@redhat.com>
* docs: trivial documentation fixes and improvementsPetr Uzel2012-02-221-11/+11
| | | | Signed-off-by: Petr Uzel <petr.uzel@suse.cz>
* build-sys: fixes to USAGE_* macrosSami Kerola2011-09-171-3/+3
| | | | | | | | | | | The USAGE_BEGIN_TAIL is removed as unnecessary. In between command specific options and --help & --version USAGE_SEPARATOR is inserted. For now the separator is empty line. The USAGE_MAN_TAIL is changed to take an argument. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
* docs: add usage() howto for contributorsSami Kerola2011-08-231-0/+147
Style instructions to usage() writers. Discussion about this; http://www.spinics.net/lists/util-linux-ng/index.html#04983 Signed-off-by: Sami Kerola <kerolasa@iki.fi>