Linux Kernel Mentees Archive on lore.kernel.org
 help / color / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
Cc: mchehab+samsung@kernel.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [Linux-kernel-mentees] [PATCH v2 2/8] Documentation: nfsroot.txt: convert to ReST
Date: Tue, 31 Dec 2019 08:32:13 -0700
Message-ID: <20191231083213.0786bda1@lwn.net> (raw)
In-Reply-To: <47e2ea6e-a808-5012-6f9a-8800fbd3be00@gmail.com>

On Tue, 31 Dec 2019 01:08:11 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> Would you please rephrase this? My first language isn't English and I am 
> not sure I understood that.
> 
> > It's best in general to avoid refilling paragraphs so as to make it clear
> > what is being changed.  But we would also like to avoid creating such long
> > lines.  Perhaps an add-on patch refilling things would satisfy both
> > criteria here.  

Changing text in an existing paragraph can
result in line lengths that are inconsistent and ragged, leading to a less 
pleasant appearance
and the temptation to "refill" the paragraph so that the 
lines are all approximately equal in length.  The problem with yielding
to that temptation is that it messes up
the diff output so that you can no longer easily see the actual
text changes that were made.

Thus, when making such changes, it can be better to not refill the
paragraphs - as, indeed, you did not.  But if the result becomes too
difficult to read (as in, it creates lines that are waaaay to long), it
can be good to create a second patch that makes only the cosmetic changes
without any associated text changes.  I was suggesting doing that in this
case.

Does that help?

Thanks,

jon
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

  reply index

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-30  4:55 [Linux-kernel-mentees] [PATCH v2 0/8] Documentation: nfs: Convert a few documents to RST and move them to admin-guide Daniel W. S. Almeida
2019-12-30  4:55 ` [Linux-kernel-mentees] [PATCH v2 1/8] Documentation: convert nfs.txt to ReST Daniel W. S. Almeida
2019-12-30 19:12   ` Jonathan Corbet
2019-12-30  4:55 ` [Linux-kernel-mentees] [PATCH v2 2/8] Documentation: nfsroot.txt: convert " Daniel W. S. Almeida
2019-12-30 19:18   ` Jonathan Corbet
2019-12-31  4:08     ` Daniel W. S. Almeida
2019-12-31 15:32       ` Jonathan Corbet [this message]
2019-12-31 19:15         ` Daniel W. S. Almeida
2019-12-30  4:55 ` [Linux-kernel-mentees] [PATCH v2 3/8] Documentation: nfs-rdma: " Daniel W. S. Almeida
2019-12-30 19:28   ` Jonathan Corbet
2019-12-30  4:55 ` [Linux-kernel-mentees] [PATCH v2 4/8] Documentation: convert nfsd-admin-interfaces " Daniel W. S. Almeida
2019-12-30 19:30   ` Jonathan Corbet
2019-12-30  4:55 ` [Linux-kernel-mentees] [PATCH v2 5/8] Documentation: nfs: idmapper: convert " Daniel W. S. Almeida
2019-12-30  4:56 ` [Linux-kernel-mentees] [PATCH v2 6/8] Documentation: nfs: convert pnfs-block-server " Daniel W. S. Almeida
2019-12-30  4:56 ` [Linux-kernel-mentees] [PATCH v2 7/8] Documentation: nfs: pnfs-scsi-server: convert " Daniel W. S. Almeida
2019-12-30  4:56 ` [Linux-kernel-mentees] [PATCH v2 8/8] Documentation: nfs: fault_injection: " Daniel W. S. Almeida

Reply instructions:

You may reply publically 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=20191231083213.0786bda1@lwn.net \
    --to=corbet@lwn.net \
    --cc=dwlsalmeida@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+samsung@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

Linux Kernel Mentees Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-kernel-mentees/0 linux-kernel-mentees/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-kernel-mentees linux-kernel-mentees/ https://lore.kernel.org/linux-kernel-mentees \
		linux-kernel-mentees@lists.linuxfoundation.org
	public-inbox-index linux-kernel-mentees

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.linuxfoundation.lists.linux-kernel-mentees


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git