Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
path: root/tools-reference
Commit message (Collapse)AuthorAgeFilesLines
* Rename "contentsTree" element to "contents"Ulrich Müller12 days1-1/+1
| | | | | | For consistency; this was the only element using camelCase. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Rename the document element from "guide" to "devbook"Ulrich Müller12 days15-30/+30
| | | | | | | | | The "guide" document element is ambiguous with the previously used GuideXML format. Now that DevBook XML has a schema, this confuses Emacs nXML mode (which uses the document element to locate a schema), e.g. when visiting old GuideXML documentation files. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/echo: Remove bash version historySebastian Engel2024-08-311-2/+1
| | | | | | | | Those bash "here strings" were introduced 22 years ago and stating the version they were implemented does not serve any purpose any more. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/echo: Format the word variable as inline codeSebastian Engel2024-08-231-1/+1
| | | | | | | | | The devmanual commonly uses <c> to format variables in text passages as code to make them more distinguishable from the rest of the text and that's why it should be done here too. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/grep: Remove the phonetic spelling of the -l parameterSebastian Engel2024-08-231-3/+2
| | | | | Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/echo: Improve wording in abuse chapterSebastian Engel2024-08-231-6/+6
| | | | | | | | "should be used as less as possible" is not a correct expression, use "should be avoided" instead. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix multiple typos and grammatical errorsSebastian Engel2024-08-122-3/+3
| | | | | Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal referencesUlrich Müller2024-05-072-2/+2
| | | | | | | Internal links referring to sections were broken by the previous "Sentence case devmanual" commit. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Sentence case devmanualMatthew Marchese2024-05-0715-51/+51
| | | | | | Signed-off-by: Matthew Marchese <maffblaster@gentoo.org> [Whitespace. Fix rebase artifact in ebuild-writing/functions/src_test.] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_prepare: Rename epatch chapter to eapplyUlrich Müller2024-04-211-1/+1
| | | | | | Update references throughout. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/diff-and-patch: No longer mention epatchUlrich Müller2024-04-211-2/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal linksUlrich Müller2023-10-301-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Explicitly specify UTF-8 encoding in XML declarationsUlrich Müller2022-10-0915-15/+15
| | | | | | As specified by the DevBook XML guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/sed: Add cross reference to "Further reading"Ulrich Müller2022-06-241-4/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: Add tables of metacharacters and constructsUlrich Müller2022-06-101-7/+54
| | | | | | | | | Parts of this have been taken from the Bash Reference Manual authored by Chet Ramey and Brian Fox. See https://bugs.gentoo.org/829916#c9. Closes: https://bugs.gentoo.org/829916 Reported-by: Alexis <flexibeast@gmail.com> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: Rework table on file comparisonUlrich Müller2022-05-271-5/+5
| | | | | | | | - Replace "same device and inode numbers" by "hard link". - Fix grammar (remove "if"). - Remove full stops (according to style guide). Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: Fix a typoUlrich Müller2022-05-271-2/+2
| | | | | | lexiographic -> lexicographic Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: More compact table formatting in source codeUlrich Müller2022-05-271-526/+270
| | | | | | No change of text. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: Remove obsolete comment about Bash 3Ulrich Müller2022-05-271-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: Drop redundant quotation marks in [[ ]] testsUlrich Müller2022-05-271-15/+9
| | | | | | | Remove a note that was recommending them. Use {} braces around variable names throughout. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove references to repomanMatt Turner2022-03-141-3/+0
| | | | | | Bug: https://bugs.gentoo.org/835013 Closes: https://github.com/gentoo/devmanual/pull/274 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* tools-reference/diff-and-patch/: add a link to "clean patches" pageJoonas Niilola2021-05-301-1/+2
| | | | | | | | - add a text link from tools-reference/diff-and-patch/index.html to ebuild-writing/misc-files/patches Signed-off-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/*: use man-page referenceSam James2021-04-076-10/+10
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/sed: emphasise need for delimiter careSam James2021-03-291-1/+6
| | | | | | Bug: https://bugs.gentoo.org/685160 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/sed: drop stray characterSam James2021-03-291-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* */*: consistent 'Portage' casingSam James2021-03-211-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference: add note about error handling in indexSam James2021-03-211-0/+6
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: elaborate on why bash tests are preferredSam James2021-03-211-0/+8
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/diff-and-patch: use name(section) notation for man pagesSam James2021-03-121-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: fix typoSam James2021-03-121-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/bash: make clear that [[ ]] is preferred earlier onSam James2021-03-121-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove unnecessary quotation marks.Ulrich Müller2020-04-071-4/+4
| | | | | | According to the style guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use unicode em-dash in titles.Ulrich Müller2020-03-1114-14/+14
| | | | | | | | Replace -- in titles by em-dashes throughout, except for QA notices in appendices/common-problems where it is replaced by a colon (which is what the actual QA notices have). Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/head-and-tail: Fix typo.Ulrich Müller2020-02-231-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Replace ">" by "&gt;" throughout.Ulrich Müller2020-02-182-4/+4
| | | | | | | Most instances are already being escaped, so convert the few remaining ones for consistency throughout the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/{diff-and-patch,false-and-true}: Fix title.Ulrich Müller2020-01-102-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update some external links.Ulrich Müller2020-01-099-30/+33
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/{cut,head-and-tail}: Space between option and argument.Ulrich Müller2020-01-092-4/+4
| | | | | | | | POSIX Utility Syntax Guidelines (Guideline 6) say that option and mandatory option-argument should be separate arguments: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html#tag_12_02 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/head-and-tail: Fix highlighting in title.Ulrich Müller2020-01-091-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/head-and-tail: Add another example for tail.Ulrich Müller2020-01-091-0/+8
| | | | | | The bad example is taken from the script referenced in bug 536654. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/head-and-tail: Line counting in tail starts at 1.Ulrich Müller2020-01-091-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove all p elements below dd.Ulrich Müller2019-12-261-11/+5
| | | | | | Where necessary, use multiple dd elements instead. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use <d/> for dashes throughout.Ulrich Müller2019-12-081-4/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix <body> elements.Ulrich Müller2019-12-085-17/+6
| | | | | | | No sectioning elements are allowed inside <body>, according to the devbook guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Mention eapply in diff and patch tools sectionBrian Evans2019-03-191-1/+2
| | | | | Closes: https://bugs.gentoo.org/652472 Signed-off-by: Brian Evans <grknight@gentoo.org>
* Replace the references to 'system' with '@system'Göktürk Yüksek2018-04-211-1/+2
| | | | | | Adopt the set notation using the '@' sign when refering to the system set. Also, system is not a target but a set. Therefore replace any references that refers to @system as 'target' with 'set'.
* Change the indentation for ebuild <codesample/> snippets from spaces to tabsGöktürk Yüksek2018-01-034-39/+39
|
* tools-reference/find: encourage the while read loop with '-print0'Göktürk Yüksek2016-10-301-11/+20
| | | | | | | | | | | | | The "funky while read loop" has problems coping with file names containing special characters. Improve it by using the '-print0' option that uses the NUL character to delimit the output lines, which can be processed safely by the while read loop by adjusting the delimiter settings. As for whether supplying $'\0' is an undocumented feature or not, see: http://lists.gnu.org/archive/html/help-bash/2016-10/msg00039.html Suggested-By: David Seifert <soap@gentoo.org>
* tools-reference/cat: add '|| die' to the here documents exampleGöktürk Yüksek2016-02-081-1/+1
| | | | Signed-off-by: Göktürk Yüksek <gokturk@binghamton.edu>
* tools-reference: remove the echangelog page #485314Michael Orlitzky2016-02-052-33/+0
| | | | | | | Since the switch to git, developers should never need to use echangelog. Remove its page from the tools-reference section. Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=485314