[pacman-dev] [PATCH] doc: add man page for pacman-conf

[Jelle van der Waa]

On 02/20/19 at 02:57am, Eli Schwartz wrote:
> On 2/20/19 2:43 AM, Allan McRae wrote:
> > On 20/2/19 5:35 pm, Eli Schwartz wrote:
> >>> +Examples
> >>> +--------
> >>> +
> >>> +pacman-conf -r core Usage::
> >>> +	Show the value of the Usage configuration option for core repository.
> >>> +
> >>> +pacman-conf HoldPkg::
> >>> +	Show the value of the HoldPkg configuration option.
> >> I'm hesitant to have an Examples section, for the simple fact that if it
> >> is needed in order to let users understand how to use the program, then
> >> the Description section has probably already failed.
> >>
> > 
> > Like the pacman man page!
> 
> I'm not necessarily saying ditch the examples section -- but its
> presence made it fairly noticeable that the rest of the page did not
> describe how pacman-conf's directive parameter functions (nor indeed
> that without it, it will flatten the configuration and return all of it
> for you).
> 
> OTOH maybe we could go wild and delete stuff from the pacman manpage
> too... who doesn't like deleting things...

In my opinion the example section is fine and can be used as a quick
reference.

-- 
Jelle van der Waa
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <https://lists.archlinux.org/pipermail/pacman-dev/attachments/20190221/b5fa7fee/attachment.sig>