public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx.manpages@gmail.com>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: Re: [PATCH v2 0/9] intro.3, libc.7, ldconfig.8: Revise
Date: Wed, 4 Jan 2023 13:34:59 +0100	[thread overview]
Message-ID: <5fc0b202-0829-42b2-760a-25e1de006e34@gmail.com> (raw)
In-Reply-To: <20230104073746.govufof5kk34nonj@illithid>


[-- Attachment #1.1: Type: text/plain, Size: 2577 bytes --]

Hi Branden,

On 1/4/23 08:37, G. Branden Robinson wrote:
> Hi Alex,
> 
> v2:
> 
> * No longer migrates `PP` macros to `P`.
> * No longer migrates ASCII "arrow" `->` to troff special character.
I'd like this change, if you can apply it globally.  But we'll leave it for a 
separate patch set.

> * 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.\

This more or less corresponds to what we call srcfix (although some might 
qualify as ffix; the ones you called imprecise).

> 
> + Style changes are a broad category encompassing corrections to
>    spelling

This more or less corresponds to what we call tfix.

> and grammar in natural language,

This more or less corresponds to what we call wfix.  wfix can englobe tfix normally.

> but also things like
>    typeface changes or changes to the style of a source code example.

This more or less corresponds to what we call ffix.  It might be good to break 
such changes in two or three separate categories, although sometimes one needs 
the other, and it's simpler to just apply one patch that does all of them.

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

And these are non-trivial patches that have their own description.


See the CONTRIBUTING file:

        -  For trivial patches, you can use subject tags:

           -  ffix: Formatting fix.
           -  tfix: Typo fix.
           -  wfix: Minor wording fix.
           -  srcfix: Change to manual page source that doesn't affect output.

           Example:

               [patch] tcp.7: tfix

Previously, we also has wsfix (white-space fix) and pfix (punctuation fix), but 
those got assimilated by the extant categories.

> 
> Regards,
> Branden

Cheers,

Alex

-- 
<http://www.alejandro-colomar.es/>

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

  reply	other threads:[~2023-01-04 12:35 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-04  7:37 [PATCH v2 0/9] intro.3, libc.7, ldconfig.8: Revise G. Branden Robinson
2023-01-04 12:34 ` Alejandro Colomar [this message]
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=5fc0b202-0829-42b2-760a-25e1de006e34@gmail.com \
    --to=alx.manpages@gmail.com \
    --cc=g.branden.robinson@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