public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: Alejandro Colomar <alx.manpages@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: [PATCH v2 0/9] intro.3, libc.7, ldconfig.8: Revise
Date: Wed, 4 Jan 2023 01:37:46 -0600	[thread overview]
Message-ID: <20230104073746.govufof5kk34nonj@illithid> (raw)

[-- Attachment #1: Type: text/plain, Size: 1181 bytes --]

Hi Alex,

v2:

* No longer migrates `PP` macros to `P`.
* No longer migrates ASCII "arrow" `->` to troff special character.
* Changes to each page split into markup, style, and content changes.

For reference, this trichotomy is one that evolved for me over the past
5-6 years while working on groff man pages.  Here is how I define them,
for reference.

+ Markup changes affect "only" the document source and are not visible
  in formatted output.  There is some imprecision in this category; I
  would regard a change to word breakpoints or hyphenation as a "markup"
  fix even though these _might_ be visible in the output depending on
  the line length of the output device (which, for terminals, is highly
  flexible).  Alterations to indentation would probably also qualify.

+ Style changes are a broad category encompassing corrections to
  spelling and grammar in natural language, but also things like
  typeface changes or changes to the style of a source code example.

+ Content changes significantly alter the informational substance of the
  page.  These include corrections to matters of fact or exposure of
  previously undocumented information.

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

             reply	other threads:[~2023-01-04  7:38 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-04  7:37 G. Branden Robinson [this message]
2023-01-04 12:34 ` [PATCH v2 0/9] intro.3, libc.7, ldconfig.8: Revise Alejandro Colomar
2023-01-04 16:05   ` G. Branden Robinson
2023-01-04 19:03     ` Alejandro Colomar
2023-01-04 19:27       ` G. Branden Robinson

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=20230104073746.govufof5kk34nonj@illithid \
    --to=g.branden.robinson@gmail.com \
    --cc=alx.manpages@gmail.com \
    --cc=linux-man@vger.kernel.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox