From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 22782 invoked from network); 31 Aug 2020 07:01:45 -0000 Received: from alyss.skarnet.org (95.142.172.232) by inbox.vuxu.org with ESMTPUTF8; 31 Aug 2020 07:01:45 -0000 Received: (qmail 22953 invoked by uid 89); 31 Aug 2020 07:02:07 -0000 Mailing-List: contact supervision-help@list.skarnet.org; run by ezmlm Sender: Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Received: (qmail 22946 invoked from network); 31 Aug 2020 07:02:06 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:subject:in-reply-to:date:message-id :mime-version; bh=0WP8l+bgJjxrNx3KgqfiUFttyQ6mSBibQ30SsD8pEXM=; b=h99B/iKq9EUwIsKV6fwOmQzYRDHCvUw0rjb6uZCnBD852wLXee9/RstqUlOQswsXnd AXAKU9araVwV74tVpsV/i0IG5EGATdT7UCimzX+ql9Mzt5JY6dCAL0sLDmaT0UfQu9wP VCaOmssGoS7W1ssdvI3VnaRgMT7xduoVtz22T1SSiVb5BcSS2WuUVtYySyKCz7lDs7W3 p2GC56GOdqUzZDjaGsA+qA4lsPyj+RWG1fw/BDO+3Odz7S5PvRos9z6zM9S7I+tZGAa/ w2D1BYW295CSqt9jsKseqpOlzj9JzyL5bN0G5IrMnV/kQngGJS1iCtBDG5H0Nvxu0tc8 o8nA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:subject :in-reply-to:date:message-id:mime-version; bh=0WP8l+bgJjxrNx3KgqfiUFttyQ6mSBibQ30SsD8pEXM=; b=MaFjiiBlN/u5RQwbbyHEin0KvErg2PXLp4AknPV5K+Z7JqXqQBMbKuyCoF4wYgZOyj VAob+mzD3G7QEvbQy/i+TelBewc0RDvyZcd0a37GjKk1xZEcgsiHlw7FFZc5ptjFALQ5 NLnY55dTHlIVhJ2t4BJbYKCoG1RwVV0UJfIRueCs4vuBCRSzzqFjlNERUq8JmJR/TCQ/ SHqNyF3JZbhvvfhvjLBPgFhJ+elcwaWkS0/86WKpEDJVMbFKVeIMAp7srF0adA4b1B1Y EdncLaWxWsSN864Exvs8MJWHhHHUOsajOj5ecY8cJu6bHGbh8hOGhLJxCES9t8i2w8iu Vqdg== X-Gm-Message-State: AOAM532TWiv3JEJHn0pHCOXTA/su76Q08Awl4yzgiDlVwsdGDqx29AvD GCo+6gJhDsj+EHzyLqT6hPkFmO8Kb0Axeg== X-Google-Smtp-Source: ABdhPJwRdQUvpuR5WalaJQFdXlTk03Dq+G+XpQRixiNAJEHUFDwd62pDpu7f3q2+t/g6h16agw9ocA== X-Received: by 2002:a17:902:5996:: with SMTP id p22mr82241pli.233.1598857298669; Mon, 31 Aug 2020 00:01:38 -0700 (PDT) References: <877dtgtu1z.fsf@ada> User-agent: mu4e 1.4.13; emacs 27.1 From: Alexis To: supervision@list.skarnet.org Subject: Re: [request for review] Port of s6 documentation to mdoc(7) In-reply-to: Date: Mon, 31 Aug 2020 17:01:34 +1000 Message-ID: <87r1rns3ht.fsf@ada> MIME-Version: 1.0 Content-Type: text/plain; format=flowed Laurent Bercot writes: > This is clearly the most advanced conversion ever > performed, well done! Thank you! > Would you be willing to add a small Makefile that by default > invokes > the mandoc commands to produce the formatted man pages, and with > an > install target that installs the source to $(MANDIR), by default > /usr/share/man ? I would then be able to review them. Thanks :) Certainly. i'll do that once i've completed a linting pass. > (AS you're aware if you've been here a while, I don't read mdoc > source, > and I will. not. learn. it.) Heh, fair enough. :-) > Would you be willing to maintain that repository > for when I make changes to the s6 documentation? Changes should > be few > and far between, except for fixes and new feature additions > (which I > don't think there will be much of). If so, I would gladly add a > link to > that repository in the official s6 home page, for people who, > like you, > prefer man pages. Sure, i'd be happy to reflect any changes. > I'd hold off on s6-rc for now, > because I'm in the process of exploring a possible redesign (for > better > integration of features that distributions want before packaging > and > using s6-rc), so it's not improbable that all the documentation > gets > rewritten in a not-too-distant future. Ah, okay - thanks for the heads-up. > What kind of changes to the text? if it's just the text of the > link, > such as changing the name of a package to the full URL of the > package, > then please go ahead and do what is needed. But relevant links > in > SEE ALSO works too. Now that i think about it some more, maybe i could simply put the link in parentheses? For example, with: a CDB file cdbfile then exits 0. where "CDB file" is a link to the relevant Wikipedia page, the mdoc would produce output like: a CDB file (http://en.wikipedia.org/wiki/Cdb_(software)) cdbfile then exits 0. Similarly, lines with a TAI64N timestamp and a space. would become: lines with a TAI64N timestamp (http://skarnet.org/software/skalibs/libstddjb/tai.html#timestamp) and a space. At any rate, i think it might be a good idea for such links to be mentioned in "SEE ALSO" regardless. > If there are other typos or grammatical errors you've noticed, > please > send them to me (maybe privately in order not to spam the list) > and I'll > fix them. If the fixes need more explanation and interactive > dialogue, > hop on #s6 some time during the week to discuss them. :) *nod* i'll try to put together an email with the relevant information, and start hanging out on #s6. :-) i'm usually on Freenode, in #voidlinux in particular, but not necessarily active at the same time as others - i'm in Melbourne.au. > Fixed in the latest git head, thanks! :-D Alexis.