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.6 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,NICE_REPLY_A autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 9780 invoked from network); 30 Aug 2020 09:07:42 -0000 Received: from alyss.skarnet.org (95.142.172.232) by inbox.vuxu.org with ESMTPUTF8; 30 Aug 2020 09:07:41 -0000 Received: (qmail 5957 invoked by uid 89); 30 Aug 2020 09:08:04 -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 5950 invoked from network); 30 Aug 2020 09:08:04 -0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=obarun.org; s=default; h=Content-Transfer-Encoding:Content-Type:Mime-Version:References: In-Reply-To:Message-Id:Subject:To:From:Date:Sender:Reply-To:Cc:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=+2qaV3ssFYkg9/8tnKbpcVHDtxJYmp7Tk+7IUEbAqLQ=; b=CC4aQpm/tkuPzsZuk74HSVOTLL Zmnsr1UmUXjzHCrJ5guOS50js2h6jRiLZENu/IAMiP1kz1KzXXJAdamltPqkY0F+Z5Y3HJtFYevro qwpqQUG8HaJryBW6duAq8BncyiiFJrHnApjO+0eScvnvFkeGX3M603R67aqWs9SxQDel/OTN1HEfk xRAIZihQng9WlXDQLwMfGSQciw/feCFadbHIo/4rKfP1RiYndPzhMPo/s2uOsAblzrCmYKeY59UqF xnH+HRWl9rAFYYdLLDh0n6eph81DbBjSstHhdncFEG3qmWylFuzDvh0HDrz7ILAiEMHazNhnZ6exQ W3YOfuag==; Date: Sun, 30 Aug 2020 20:10:34 +1100 From: eric vidal To: supervision@list.skarnet.org Subject: Re: [request for review] Port of s6 documentation to mdoc(7) Message-Id: <20200830201034.e19b67e197447221f99a7e79@obarun.org> In-Reply-To: <877dtgtu1z.fsf@ada> References: <877dtgtu1z.fsf@ada> X-Mailer: Sylpheed 3.7.0 (GTK+ 2.24.32; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - sv26.byethost26.org X-AntiAbuse: Original Domain - list.skarnet.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - obarun.org X-Get-Message-Sender-Via: sv26.byethost26.org: authenticated_id: eric@obarun.org X-Authenticated-Sender: sv26.byethost26.org: eric@obarun.org X-Source: X-Source-Args: X-Source-Dir: On Sun, 30 Aug 2020 18:30:16 +1000 Alexis wrote: > > Hi all, > > i recently started using 66 instead of runit on Void - thanks to > @Obarun, @mobinmob and @teldra for their work and help! You're welcome. Thank at you to use 66. > 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. This is really a hard job to do. Many thanks to make it. A lot of user will appreciate it. Well, i'm not really good at English, so my help will not be usefull about grammatical issues. But i will do some publicizes about your work that be visible by user. -- eric vidal