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 5700 invoked from network); 30 Aug 2020 08:30:32 -0000 Received: from alyss.skarnet.org (95.142.172.232) by inbox.vuxu.org with ESMTPUTF8; 30 Aug 2020 08:30:32 -0000 Received: (qmail 5201 invoked by uid 89); 30 Aug 2020 08:30:49 -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 5193 invoked from network); 30 Aug 2020 08:30:49 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=user-agent:from:to:subject:date:message-id:mime-version; bh=My+RH+VrH20zBvs59G6z/34LTStRe4P+N30E03TRySA=; b=b0Z9c0lU0P1OJwbkOibhmeTBSSc6DFKpdZ7YcMzkjv2L8+RVY3VsJ0qJoAMjKpmrxU uuYuQ1mMrqcV4965oHEzIn7x82Och1iD1SVPml/G1OwdSlDtSxwlsQbWFOlWcn4TeLKk lsryFDJHLHBsYngX5+ps/0PEw83dTtWIk2Sgyy1T7+NGdXrBrz2Bo9WmEgmze5mF5v5M ucYPKvI3QKpduo64nmjrFEu8xewsW1KNeXlDS0F18Q7BSeFLhJ6jaJmT8E/9dk34/VPe o3OnVdRJWVXx3FdQPUxFdyXFeRjFuwInxhPsel5LKlIL8E2nQ2UfJBGb3BV+0VtOiq7v ZkfQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:user-agent:from:to:subject:date:message-id :mime-version; bh=My+RH+VrH20zBvs59G6z/34LTStRe4P+N30E03TRySA=; b=EWCMrr0IdD6kK2XnuU46hfb9Wz8EcnCXVSIbMObsvzJJ5Jqe8gUcanF3Ohq8wFddn0 Upd3vkLO14mcpdoe3RWNiX2GPqGo9icanCEZJKlWp4Bh1j+D8daiTDmW/BFrJMwELS/H 5QHVb2Ck8d0D2Boi3/z+V5ysAQkFyQRfHeV2iKTWUsxE1Y5+fSC48ZdPUIB8WNciGVcI 01I3cwhbR8qkOUKowvbW81BVCahB+DrCrBo+aWKMRs+XSYhiQi10rKHRt5KqGAlt5H8R U3YGh+k9K8tLVSUAGZUiUIqUNGBVjpmhgM4DwmqWY3KJt13GiVn146F5E5rbF+KRoLwA O9lQ== X-Gm-Message-State: AOAM530bjO9bgTdV0sDkwTz56YlWH7hazuPpfbjZo4dmJ+YPmXJ5VIpg iNsROHOoi6X6vg/vJTQ0Ip9rmlPrzcA= X-Google-Smtp-Source: ABdhPJymt+Sd+/6t0Wa9QRQeLcw3FkzgZFnf0W5yE1U382oXCufPDMFFA8YD0plZerQrdWdti09JEw== X-Received: by 2002:a17:90a:4ec6:: with SMTP id v6mr5584123pjl.12.1598776220534; Sun, 30 Aug 2020 01:30:20 -0700 (PDT) User-agent: mu4e 1.4.13; emacs 27.1 From: Alexis To: supervision@list.skarnet.org Subject: [request for review] Port of s6 documentation to mdoc(7) Date: Sun, 30 Aug 2020 18:30:16 +1000 Message-ID: <877dtgtu1z.fsf@ada> MIME-Version: 1.0 Content-Type: text/plain; format=flowed Hi all, i recently started using 66 instead of runit on Void - thanks to @Obarun, @mobinmob and @teldra for their work and help! Consequently, and further to https://www.mail-archive.com/supervision@list.skarnet.org/msg02278.html : > if people like man pages, they should have man pages, so it's > been a > few years that I have appealed to the community for this ... I > want > s6 to be accessible, but I figure that if people really wanted > man > pages, they'd write man pages i've spent the last couple of weeks porting the s6 documentation to mdoc(7) format: https://github.com/flexibeast/s6-man-pages since i really want man pages, and much prefer them to HTML for system-level software. :-) i don't consider the current state of the repo to be 'ready' in a general sense, but i do feel it's mostly done, and certainly amenable to review. i think this might be a good time to give myself a short break from working on it, so i can then come back and do a review pass with fresher eyes. The porting has been done manually, with no automation involved; this has allowed me to use semantic markup as much as possible, which of course also facilitates searching for content with `apropos(1)`. Several things to note: * i've changed page layouts to fit mdoc(7) conventions. * During the porting process, i developed ideas about what might be the best way to do things, so documentation ported earlier might not follow the same style as the documentation ported more recently. This is something i hope to check in my review pass. * There are currently no cross-references to the execline suite or skalibs. However, i'm willing to port that documentation as well, together with the s6-rc documentation. * Inline links to things such as djb's software are not yet included. The `Lk` macro allows one to supply link text as well as the URL, but the resulting output would require changes to the text to make it read satisfactorily. Regardless, i can add the relevant links in "SEE ALSO" sections. * i've corrected a number of typos and grammatical issues, and discovered what i believe might be couple of errors: * s6-softlimit: The "Options" section refers to "-r allmem" rather than "-r res". * s6-ftrig-listen: The "Options" section says: "By default, s6-ftrig-listen1 waits indefinitely for a matching series of events." Given the context, i presume this should be "s6-ftrig-listen"? That said, although i've tried to be careful, i might have introduced new errors, or made mistakes in my choice of macros, so proofreading would be appreciated. :-) Alexis.