Mail archive
alpine-devel

Re: [alpine-devel] Improving Alpine Linux documentation

From: William Pitcock <nenolod_at_dereferenced.org>
Date: Tue, 12 Dec 2017 16:08:44 -0600

Hi,

On Tue, Dec 12, 2017 at 3:53 PM, Drew DeVault <sir_at_cmpwn.com> wrote:
> On 2017-12-12 11:34 PM, Consus wrote:
>> True. But this is more about the high-level documentation, not the
>> tool's synopsis.
>
> Man pages are not limited to the synopsis of tools. Large portions of
> information currently on the wiki is on-topic for man pages:
>
> https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management
>
> apk(8)
>
> https://wiki.alpinelinux.org/wiki/Apk_spec
>
> apk-database(7)
>
> https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package
> https://wiki.alpinelinux.org/wiki/APKBUILD_Reference
>
> abuild(1)
>
> APKBUILD(7)
>
> and so on. If an overhaul of the core docs on the wiki is due, then I
> think lots of it should be moved into man pages as the single source of
> truth.

I agree, with the exception that the apk-related manpages should be
written in mdoc (as I said elsewhere). I think it makes sense also to
be consistent with that policy in apk for abuild, too.

William


---
Unsubscribe:  alpine-devel+unsubscribe_at_lists.alpinelinux.org
Help:         alpine-devel+help_at_lists.alpinelinux.org
---
Received on Tue Dec 12 2017 - 16:08:44 GMT