Page MenuHomeFreeBSD

Porter's Handbook: add hint about use of REINPLACE
Needs ReviewPublic

Authored by linimon on Jan 5 2020, 9:48 PM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 27 2024, 4:41 PM
Unknown Object (File)
Jan 18 2024, 9:11 AM
Unknown Object (File)
Jan 11 2024, 7:12 PM
Unknown Object (File)
Dec 20 2023, 5:53 AM
Unknown Object (File)
Dec 19 2023, 4:13 AM
Unknown Object (File)
Nov 6 2023, 9:46 AM
Unknown Object (File)
Oct 5 2023, 8:44 AM
Unknown Object (File)
Aug 25 2023, 2:48 AM
Subscribers

Details

Reviewers
mat
Group Reviewers
portmgr
Summary

Add a trivial hint about using REINPLACE: avoid using comma as the delimiter. (This can mess up e.g. CFLAGS modifications.)

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

Eliminate lines that belong to D19239.

REINPLACE does not exist.

This comes out of nowhere, one wonders what uses cases it is trying to fix.

Hints usually comes by the form of a <tip> tag, and it usually goes along where something is defined. In this case, it should go in https://www.freebsd.org/doc/en/books/porters-handbook/slow-patch.html in 4.4.3. Simple Automatic Replacements.

Comma , is often chosen as the delimiter because of its very little occupied space which helps readability. Pipe | is okayish, I use it sometimes as well, colon : and semicolon ; also look fine. At-sign @ and hash # are quite heavy and interlink with the actual editable text, so I'd avoid them.

That said, there's no "always good" choice. We avoid slashes / because of the path separators, and similarly we can simply avoid commas , when dealing with compiler/linker options, but PHB should not recommend to never use them.