From: "Anthony J. Bentley" <anthony@anjbe.name> To: "Jason A. Donenfeld" <Jason@zx2c4.com> Cc: discuss@mandoc.bsd.lv, Stephen Gregoratto <dev@sgregoratto.me> Subject: Re: [PATCH] Fix formatting in wg-quick(8) Date: Fri, 14 Feb 2020 15:36:38 -0700 [thread overview] Message-ID: <10339-1581719798.184667@sTB8.3w_H.FchF> (raw) In-Reply-To: <CAHmME9os+117_K-Uah5hrdfucCXiMD1B9-p-2vQ1Kg+3ERqPiw@mail.gmail.com> Hi Jason, Forgive brevity, I have no computer this weekend. Jason A. Donenfeld writes: > - You got rid of the specifically bolded lines in som > e of the wg-quick > examples. As stated elsewhere in this thread, those a > re intentional. Sorry, I overlooked that. > - One of the wg-quick examples doesn't have a trailin > g new line, > making it look awkward with the next paragraph. Mistake, I think Ingo corrected it. > - The ... in the command summary is now underlined an > d inside the [ ], > which seems different from other man pages on my mach > ine. > - You now put quotes around referenced commands inste > ad of underlines. > Is that normal? > - IP addresses are now quoted instead of underlined. > Is that normal? > It certainly sticks out less. > - You got rid of the <carrots> for sub command argume > nts. Is that > correct? Other commands seem to use the <carrots>. > - The indented example commands are no longer "blue", > which seems odd. > - While some things are now quoted that were previous > ly underlined, > other things that were emboldened are now quoted. Wha > t's up here? These formatting changes more or less come with the mdoc semantic markup. This is consistent with BSD man page style. There are some conflicts with the non-mdoc way of doing things perhaps. In general I think the semantics are worth it (especially with mandoc's searching, tagging, HTML generation capabilities). > Did you change any wording at all? It's quite importa > nt to me that the > actual words don't change at all without an explicit > patch for that so > it can be reviewed. In other words, I don't want word > ing changes > sneaking in with the typesetting rewrite. Except where I introduced semantic markup, I tried to keep things the same. It's possible there's a place or two where I changed something without thinking. But I tried to avoid it. > Again, thanks a lot for working on this. I really app > reciate it. Side note... last time I poked at WireGuard manpages, it resulted in this commit: https://github.com/openbsd/src/commit/df9a9479ddee899e1995f8eba1983628deecbec6 -- Anthony J. Bentley -- To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv
next prev parent reply other threads:[~2020-02-14 22:36 UTC|newest] Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top [not found] <CAHmME9rVyL+QUhks0J8xOpykb6V+5wKadgowc8bndP=Shi5gyA@mail.gmail.com> 2020-02-11 22:59 ` discrepancy between groff and mandoc for html rendering of wg-quick(8) Jason A. Donenfeld 2020-02-12 7:02 ` Jan Stary 2020-02-12 15:06 ` Ingo Schwarze 2020-02-12 15:14 ` Jan Stary 2020-02-12 15:25 ` Ingo Schwarze 2020-02-12 21:44 ` Ingo Schwarze 2020-02-13 4:29 ` Stephen Gregoratto 2020-02-13 4:49 ` [PATCH] Fix formatting in wg-quick(8) Stephen Gregoratto 2020-02-13 8:57 ` Raf Czlonka 2020-02-13 16:31 ` Jason A. Donenfeld 2020-02-13 18:34 ` Ingo Schwarze 2020-02-13 17:57 ` Ingo Schwarze 2020-02-13 18:00 ` Jason A. Donenfeld 2020-02-13 19:34 ` Ingo Schwarze 2020-02-13 19:55 ` Jason A. Donenfeld 2020-02-13 22:28 ` Ingo Schwarze 2020-02-13 22:38 ` Jason A. Donenfeld 2020-02-13 22:44 ` Jan Stary 2020-02-13 23:21 ` Steffen Nurpmeso 2020-02-14 4:00 ` Anthony J. Bentley 2020-02-14 11:08 ` Jason A. Donenfeld 2020-02-14 15:05 ` Ingo Schwarze 2020-02-14 22:36 ` Anthony J. Bentley [this message] 2020-02-14 18:20 ` Ingo Schwarze 2020-02-15 0:45 ` [PATCH v2] Rewrite wg-quick.8 in mdoc Stephen Gregoratto 2020-02-15 19:53 ` Jason A. Donenfeld 2020-02-16 10:32 ` Stephen Gregoratto 2020-02-16 15:52 ` Ingo Schwarze 2020-02-13 16:34 ` discrepancy between groff and mandoc for html rendering of wg-quick(8) Jason A. Donenfeld
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=10339-1581719798.184667@sTB8.3w_H.FchF \ --to=anthony@anjbe.name \ --cc=Jason@zx2c4.com \ --cc=dev@sgregoratto.me \ --cc=discuss@mandoc.bsd.lv \ --subject='Re: [PATCH] Fix formatting in wg-quick(8)' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).