Guillem Jover wrote:
> On Sun, 2012-10-28 at 02:53:57 -0700, Jonathan Nieder wrote:
>> Here's another try at putting it in the description of --export. What
>> do you think?
>
> Certainly an improvement, although I'm not yet sold on the embedded
> examples, it would probably also make more sense to format them all
> in the same way too.
Ok, I should probably say more about why I put those examples there. :)
The dpkg-buildflags command has several different modes, each producing
a different kind of output and with a different intended use.
So:
--dump - list of "flag=value" lines, meant to be parsed explicitly
--list - list of flags, good for setting up a loop
--status - human-readable output
--export=sh - shell commands to export flags as envvars
--export=configure - ./configure args to make use of flags
--export=make - makefile fragment to export flags as envvars
--get - raw flag value
--origin - machine-readable flag origins, can be useful in
conditionals (like "make"'s 'origin' function)
--query-features - very verbose key/value list describing the
semantics of flags. This is plumbing for
hardening checkers, I suspect. :)
The brief examples are a clumsy attempt to describe the purpose of
each "--export" mode, and implicitly to specify the output format as
well ("the output is what will work in this construct").
Formatting: the inline examples are in bold like most literal commands
in the manpage. One of the examples is offset using .ft because it
required multiple lines.
I recommend using "man" or "man -t" to look at the manpage with the
patch applied, to more easily look at the wording without distracting
markup. If anyone has improvements for the text or organization, I'll
be happy to incorporate them and reroll the patch.
Thanks,
Jonathan
--
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
