Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sentence case #335

Merged
merged 4 commits into from
May 7, 2024
Merged

Sentence case #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb8f7e5
Sentence case devmanual
maffblaster Dec 21, 2023
5196ecf
ebuild-writing/misc-files/patches: Revert wording change
ulm Apr 29, 2024
fd9c034
Fix internal references
ulm Apr 29, 2024
fe83e87
More sentence case changes
ulm Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions appendices/common-problems/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/common-problems/">
<chapter>
<title>Common Problems</title>
<title>Common problems</title>
<body>

<p>
Expand All @@ -11,7 +11,7 @@ and QA notices.
</body>

<section>
<title>Handling QA Notices</title>
<title>Handling QA notices</title>
<body>

<p>
Expand All @@ -28,7 +28,7 @@ covered here.
</body>

<subsection>
<title>QA Notice: USE Flag foo not in IUSE</title>
<title>QA notice: USE flag foo not in IUSE</title>
<body>

<p>
Expand All @@ -42,7 +42,7 @@ See <uri link="::ebuild-writing/variables/#IUSE"/> and
</subsection>

<subsection>
<title>QA Notice: foo in global scope</title>
<title>QA notice: foo in global scope</title>
<body>

<p>
Expand All @@ -59,8 +59,8 @@ in use, there are various alternatives:
Usually when any of the above are used in global scope, it is to manipulate
a version or program name string. These should be avoided in favour of pure
<c>bash</c> constructs. The built-in helpers of EAPI 7 are useful here. See
<uri link="::ebuild-writing/variables/#Version and Name Formatting Issues"/>
and <uri link="::tools-reference/bash/#Bash Variable Manipulation"/>.
<uri link="::ebuild-writing/variables/#Version and name formatting issues"/>
and <uri link="::tools-reference/bash/#Bash variable manipulation"/>.
</dd>
<dt>
<c>has_version</c>, <c>best_version</c>
Expand All @@ -86,7 +86,7 @@ in use, there are various alternatives:
</subsection>

<subsection>
<title>QA Notice: foo is setXid, dynamically linked and using lazy bindings</title>
<title>QA notice: foo is setXid, dynamically linked and using lazy bindings</title>
<body>

<p>
Expand All @@ -101,7 +101,7 @@ for security reasons. If this message is shown, you have a couple of options:
</li>
<li>
Use <c>append-ldflags</c> (see
<uri link="::ebuild-writing/functions/src_compile/build-environment/#Adding Additional Flags"/>)
<uri link="::ebuild-writing/functions/src_compile/build-environment/#Adding additional flags"/>)
to add <c>-Wl,-z,now</c>. This will affect <e>all</e> binaries installed, not just the setXid ones.
</li>
</ul>
Expand All @@ -110,7 +110,7 @@ for security reasons. If this message is shown, you have a couple of options:
</subsection>

<subsection>
<title>QA Notice: ECLASS foo inherited illegally</title>
<title>QA notice: ECLASS foo inherited illegally</title>
<body>

<p>
Expand All @@ -131,7 +131,7 @@ inheritance occurring. Most commonly:
</li>
<li>
When working with eclasses in an overlay with a stale cache. See <uri
link="::general-concepts/overlay/#Overlay and Eclasses"/>.
link="::general-concepts/overlay/#Overlay and eclasses"/>.
</li>
<li>
When working with a stale Portage cache.
Expand All @@ -150,7 +150,7 @@ you see this notice locally. If you see this notice when working with a pure
</section>

<section>
<title>Handling Access Violations</title>
<title>Handling access violations</title>
<body>

<p>
Expand Down
8 changes: 4 additions & 4 deletions appendices/contributing/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/contributing/">
<chapter>
<title>Contributing to This Document</title>
<title>Contributing to this document</title>

<body>
<p>
Expand Down Expand Up @@ -70,7 +70,7 @@ top-level directory, which will validate all XML files using <c>xmllint</c>.
</section>

<section>
<title>Quick Introduction to DevBook XML</title>
<title>Quick introduction to DevBook XML</title>
<body>

<p>
Expand Down Expand Up @@ -98,7 +98,7 @@ amount of depth.
definition lists. Do <e>not</e> indent text in ordinary paragraph blocks.
</dd>
<dt>
Code Samples
Code samples
</dt>
<dd>
You can use the normal GuideXML tag <c>&lt;pre&gt;</c> when you need
Expand All @@ -124,7 +124,7 @@ amount of depth.
</section>

<section>
<title>Style Guidelines</title>
<title>Style guidelines</title>
<body>

<ul>
Expand Down
16 changes: 8 additions & 8 deletions appendices/contributors/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ This page lists the contributions to the Gentoo Development Guide:

<authors>
<author name="Ciaran McCreesh" email="ciaran.mccreesh@blueyonder.co.uk">
Main Content
Main content
</author>
<author name="Grant Goodyear" email="g2boojum@gentoo.org">
<uri link="::tools-reference/cat/#Here Documents"/>
<uri link="::tools-reference/cat/#Here documents"/>
</author>
<author name="Aaron Walker" email="ka0ttic@gentoo.org">
<uri link="::tasks-reference/completion/"/>
Expand All @@ -23,7 +23,7 @@ This page lists the contributions to the Gentoo Development Guide:
</author>
<author name="Tom Martin" email="slarti@gentoo.org">
<uri link="::appendices/editor-configuration/emacs/"/>,
<uri link="::general-concepts/use-flags/#Conflicting USE Flags"/>
<uri link="::general-concepts/use-flags/#Conflicting USE flags"/>
</author>
<author name="Paul Varner" email="fuzzyray@gentoo.org">
<uri link="::ebuild-writing/functions/src_unpack/rpm-sources/"/>
Expand All @@ -33,7 +33,7 @@ This page lists the contributions to the Gentoo Development Guide:
</author>
<author name="Diego Pettenò" email="flameeyes@gentoo.org">
<uri link="::tasks-reference/pam/"/>,
<uri link="::general-concepts/autotools/#aclocal and m4 Files"/>
<uri link="::general-concepts/autotools/#aclocal and m4 files"/>
</author>
<author name="Fernando J. Pereda" email="ferdy@gentoo.org">
<uri link="::archs/alpha/"/>
Expand All @@ -50,10 +50,10 @@ This page lists the contributions to the Gentoo Development Guide:
<uri link="::archs/ppc/"/>
</author>
<author name="Ursula Maplehurst" email="plasm@roo.me.uk">
Previous maintainer (XSL Stylesheets, legacy Developer Handbook content)
Previous maintainer (XSL stylesheets, legacy Developer Handbook content)
</author>
<author name="Mark Loeser" email="halcy0n@gentoo.org">
XSL Stylesheets, previous maintainer
XSL stylesheets, previous maintainer
</author>
<author name="Petteri Räty" email="betelgeuse@gentoo.org">
<uri link="::ebuild-writing/"/>,
Expand All @@ -68,7 +68,7 @@ Misc
<uri link="::ebuild-maintenance/"/>,
<uri link="::appendices/editor-configuration/emacs/"/>,
<uri link="::appendices/devbook-guide/"/>,
DTD, XSL stylesheet, eclass conversion
DTD, XSL stylesheets, eclass conversion
</author>
<author name="Mike Pagano" email="mpagano@gentoo.org">
<uri link="::general-concepts/news/"/>
Expand Down Expand Up @@ -123,7 +123,7 @@ Misc
Search functionality
</author>
<author name="Mike Frysinger" email="vapier@gentoo.org">
<uri link="::ebuild-writing/misc-files/patches/#Clean Patch Howto"/>
<uri link="::ebuild-writing/misc-files/patches/#Clean patch howto"/>
</author>
<author name="Sam James" email="sam@gentoo.org">
<uri link="::eclass-writing/"/>,
Expand Down
24 changes: 12 additions & 12 deletions appendices/devbook-guide/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/devbook-guide/">
<chapter>
<title>Gentoo DevBook XML Guide</title>
<title>Gentoo DevBook XML guide</title>

<section>
<title>DevBook XML design goals</title>
Expand Down Expand Up @@ -36,7 +36,7 @@ used in a DevBook XML document:
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;guide self="appendices/devbook-guide/"&gt;
&lt;chapter&gt;
&lt;title&gt;Gentoo DevBook XML Guide&lt;/title&gt;
&lt;title&gt;Gentoo DevBook XML guide&lt;/title&gt;
</codesample>

<p>
Expand Down Expand Up @@ -533,30 +533,30 @@ here syndrome</uri> as recommended by the
<p>
DevBook XML makes it really easy to reference other parts of the document using
hyperlinks. You can create a link pointing to another chapter, like
<uri link="::ebuild-writing/file-format/">Ebuild File Format</uri>, by typing
<c>&lt;uri link="::ebuild-writing/file-format/"&gt;Ebuild File
Format&lt;/uri&gt;</c>, i.e., two colons followed by the relative path from
<uri link="::ebuild-writing/file-format/">Ebuild file format</uri>, by typing
<c>&lt;uri link="::ebuild-writing/file-format/"&gt;Ebuild file
format&lt;/uri&gt;</c>, i.e. two colons followed by the relative path from
the root node. To refer to a section in another chapter, like
<uri link="::quickstart/#First Ebuild">First Ebuild</uri>, type
<c>&lt;uri link="::quickstart/#First Ebuild"&gt;First Ebuild&lt;/uri&gt;</c>.
<uri link="::quickstart/#First ebuild">First ebuild</uri>, type
<c>&lt;uri link="::quickstart/#First ebuild"&gt;First ebuild&lt;/uri&gt;</c>.
</p>

<p>
If the link target's chapter (or section etc.) title is to be used as the link
text, an empty <c>&lt;uri&gt;</c> element can be used. As a matter of fact,
I could have written the two examples above in more compact form:
<c>&lt;uri link="::ebuild-writing/file-format/"/&gt;</c> and
<c>&lt;uri link="::quickstart/#First Ebuild"/&gt;</c> render as
<c>&lt;uri link="::quickstart/#First ebuild"/&gt;</c> render as
<uri link="::ebuild-writing/file-format/"/> and
<uri link="::quickstart/#First Ebuild"/>, respectively.
<uri link="::quickstart/#First ebuild"/>, respectively.
</p>

</body>
</subsection>
</section>

<section>
<title>Coding Style</title>
<title>Coding style</title>
<body>

<p>
Expand All @@ -574,7 +574,7 @@ Both sections are described next.
</body>

<subsection>
<title>Internal Coding Style</title>
<title>Internal coding style</title>
<body>

<p>
Expand Down Expand Up @@ -674,7 +674,7 @@ fixed-width font.
</body>
</subsection>
<subsection>
<title>External Coding Style</title>
<title>External coding style</title>
<body>

<p>
Expand Down
2 changes: 1 addition & 1 deletion appendices/editor-configuration/emacs/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ for each document type.
</section>

<section>
<title>Further Reading</title>
<title>Further reading</title>
<body>

<ul>
Expand Down
2 changes: 1 addition & 1 deletion appendices/editor-configuration/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/editor-configuration/">
<chapter>
<title>Editor Configuration</title>
<title>Editor configuration</title>
<body>

<p>
Expand Down
2 changes: 1 addition & 1 deletion appendices/further-reading/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/further-reading/">
<chapter>
<title>Further Reading</title>
<title>Further reading</title>
<body>

<p>
Expand Down
2 changes: 1 addition & 1 deletion appendices/todo-list/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/todo-list/">
<chapter>
<title>TODO List</title>
<title>TODO list</title>
<body>
<p>
This TODO list is automatically generated from the <c>&lt;todo&gt;</c> directives in other documents.
Expand Down
14 changes: 7 additions & 7 deletions archs/alpha/text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="archs/alpha/">
<chapter>
<title>Arch Specific Notes — Alpha</title>
<title>Arch specific notes — Alpha</title>
<body>

<p>
Expand All @@ -12,7 +12,7 @@ The Alpha port uses the <c>alpha</c> keyword. It focuses upon HP (formerly Compa
</body>

<section>
<title>Alpha Kernel and Userland ABIs</title>
<title>Alpha kernel and userland ABIs</title>
<body>

<p>
Expand All @@ -28,7 +28,7 @@ little endian.
</section>

<section>
<title>Additional Alpha Keywording Requirements</title>
<title>Additional Alpha keywording requirements</title>
<body>

<p>
Expand All @@ -42,7 +42,7 @@ like to know about it.
</section>

<section>
<title>Alpha Instruction Set and Performance Notes</title>
<title>Alpha instruction set and performance notes</title>
<body>

<p>
Expand Down Expand Up @@ -87,7 +87,7 @@ which the compiler was built.
<p>
The <c>-mieee</c> flag <b>should</b> always be used unless you have a deep knowledge
of the Alpha architecture, so the comments on
<uri link="::general-concepts/user-environment/#Not Filtering Variables"/> are
<uri link="::general-concepts/user-environment/#Not filtering variables"/> are
really important on Alpha.
</p>

Expand All @@ -108,7 +108,7 @@ this results in errors during the compilation aborting emerge.
</section>

<section>
<title>Contacting the Alpha Team</title>
<title>Contacting the Alpha team</title>
<body>

<p>
Expand All @@ -134,7 +134,7 @@ The Alpha team can be contacted:
</section>

<section>
<title>Other Resources</title>
<title>Other resources</title>
<body>

<ul>
Expand Down
Loading
Loading