Bug 267425 - Warn against trailing white space
Summary: Warn against trailing white space
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Sergio Carlavilla Delgado
URL: https://git-scm.com/docs/git-apply
Keywords: needs-patch, needs-qa
Depends on:
Blocks:
 
Reported: 2022-10-30 00:08 UTC by Graham Perrin
Modified: 2023-08-26 07:17 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2022-10-30 00:08:39 UTC
As far as I can tell: neither the Committer's Guide, nor the FreeBSD Documentation Project Primer for New Contributors, offers a plain warning. 

<https://docs.freebsd.org/en/articles/committers-guide/>
<https://docs.freebsd.org/en/books/fdp-primer/book/>

<https://reviews.freebsd.org/D37086#844064> exemplifies the error that may occur, with use of git-apply(1), if a trail exists: 

> …
> warning: 2 lines add whitespace errors.


<https://docs.freebsd.org/en/books/fdp-primer/book/#editor-config-nano-config> can be a clue only if the editor (the human) decides to read and interpret the content of the suggested ~/.nanorc file for nano(1).
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2022-10-30 01:20:30 UTC
I guess, this belongs somewhere under The FreeBSD Committers' Big List of Rules. 

<https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/articles/committers-guide/_index.adoc#203-other-suggestions> currently has white space suggestions in the midst of the third paragraph. I'd split this paragraph; reorder and expand its content; make it more positive than negative …

… and maybe include a link out/across to editor configuration, i.e. <https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/fdp-primer/editor-config/_index.adoc>.
Comment 2 Pau Amma 2022-10-30 02:32:14 UTC
(In reply to Graham Perrin from comment #1)
I'd add it to the FDP primer as well, under https://docs.freebsd.org/en/books/fdp-primer/writing-style/#writing-style-guidelines or elsewhere in that chapter.
Comment 3 Graham Perrin freebsd_committer freebsd_triage 2022-10-30 07:39:47 UTC
(In reply to Pau Amma from comment #2)

Agreed. 

Bug 267428 first.