@@ -62,8 +62,8 @@ on Debian and Ubuntu::
Then, you need to set a name and e-mail address that Git will
use to identify your commits::
- $ git config --global user.name "Ada Lovelace"
- $ git config --global user.email "ada.lovelace@gmail.com"
+ $ git config --global user.name "<firstname> <lastname>"
+ $ git config --global user.email "<email>"
By default, Git adds a signature line at the end of patches containing the Git
version. We suggest to remove it as it doesn't add useful information.
@@ -394,13 +394,14 @@ Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or
through a direct SMTP configuration in your Git ``~/.gitconfig`` file.
Here are the settings for letting ``git send-email`` send e-mail through your
-regular STMP server, using a Google Mail account as an example::
+regular STMP server, such as ``smtp.gmail.com`` for a Google Mail
+account::
- $ git config --global sendemail.smtpserver smtp.gmail.com
+ $ git config --global sendemail.smtpserver <smtp server>
$ git config --global sendemail.smtpserverport 587
$ git config --global sendemail.smtpencryption tls
- $ git config --global sendemail.smtpuser ada.lovelace@gmail.com
- $ git config --global sendemail.smtppass = XXXXXXXX
+ $ git config --global sendemail.smtpuser <email>
+ $ git config --global sendemail.smtppass <password>
These settings will appear in the ``.gitconfig`` file in your home directory.
@@ -517,7 +518,7 @@ author name. The following will ensure that your e-mails have an additional
maintainers accepting your patches don't have to fix commit author information
manually::
- $ git config --global sendemail.from "linus.torvalds@kernel.org"
+ $ git config --global sendemail.from "<email>"
The ``sendemail.from`` should match your ``user.email`` setting,
which appears in the ``Signed-off-by`` line of your commits.
@@ -810,7 +810,7 @@ be visible. In this case, there is a missing dependency for the ``neard``
Makefile target. Here is some abbreviated, sample output with the
missing dependency clearly visible at the end::
- i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/......
+ i586-poky-linux-gcc -m32 -march=i586 --sysroot=<path/to/sysroot>
.
.
.
@@ -1114,11 +1114,11 @@ debugger.
After running gdbserver on the target, you need to run Gdb on the
host and configure it and connect to the target. Use these commands::
- $ cd directory-holding-the-debugfs-directory
- $ arch-gdb
+ $ cd <debugfs-directory>
+ $ <arch>-gdb
(gdb) set sysroot debugfs
(gdb) set substitute-path /usr/src/debug debugfs/usr/src/debug
- (gdb) target remote IP-of-target:1234
+ (gdb) target remote <IP-of-target>:1234
At this
point, everything should automatically load (i.e. matching binaries,
@@ -193,9 +193,9 @@ The support for having multiple Git revisions per URL in :term:`SRC_URI` was
removed from BitBake, which means the following syntax is not supported
anymore::
- SRC_URI = "git://some.host/somepath;bareclone=1;branch=branchX,branchY;name=nameX,nameY"
- SRCREV_nameX = "xxxxxxxxxxxxxxxxxxxx"
- SRCREV_nameY = "yyyyyyyyyyyyyyyyyyyy"
+ SRC_URI = "git://<some.host>/<somepath>;bareclone=1;branch=<branchX>,<branchY>;name=<nameX>,<nameY>"
+ SRCREV_<nameX> = "<revision SHA for nameX>"
+ SRCREV_<nameY> = "<revision SHA for nameY>"
This was rarely used in the core repositories because it would only ever make
sense for bare clones (the ``bareclone=1`` :term:`SRC_URI` option) where recipes
@@ -205,10 +205,10 @@ places.
If one of your recipes is using this mechanism, you can split the code source
fetching into two separate entries::
- SRC_URI = "git://some.host/somepath;bareclone=1;branch=branchX;name=nameX \
- git://some.host/somepath;bareclone=1;branch=branchY;name=nameY"
- SRCREV_nameX = "xxxxxxxxxxxxxxxxxxxx"
- SRCREV_nameY = "yyyyyyyyyyyyyyyyyyyy"
+ SRC_URI = "git://<some.host>/<somepath>;bareclone=1;branch=<branchX>;name=<nameX> \
+ git://<some.host>/<somepath>;bareclone=1;branch=<branchY>;name=<nameY>"
+ SRCREV_<nameX> = "<revision SHA for nameX>"
+ SRCREV_<nameY> = "<revision SHA for nameY>"
Git fetcher: Branch parameter now required in :term:`SRC_URI`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -216,7 +216,7 @@ Git fetcher: Branch parameter now required in :term:`SRC_URI`
The ``branch`` parameter is now required when specifying a Git repository in
:term:`SRC_URI`, for example::
- SRC_URI = "git://some.host/somepath;branch=branchX"
+ SRC_URI = "git://<some.host>/<somepath>;branch=<branchX>"
A missing ``branch`` parameter used to produce a warning, and will now produce
an error.
@@ -474,7 +474,7 @@ This is roughly equivalent to the ``devtool update-recipe`` command followed by
the ``devtool reset`` command. The changes must have been committed to the git
repository created by ``devtool``. Here is an example::
- $ devtool finish recipe /path/to/custom/layer
+ $ devtool finish <recipe> <path/to/custom/layer>
.. _devtool-building-your-recipe:
@@ -162,7 +162,7 @@ system and gives an overview of their function and contents.
ARCHIVER_MODE[src] = "patched" # Uses patched source files. This is the default.
ARCHIVER_MODE[src] = "configured" # Uses configured source files.
ARCHIVER_MODE[diff] = "1" # Uses patches between do_unpack and do_patch.
- ARCHIVER_MODE[diff-exclude] ?= "file file ..." # Lists files and directories to exclude from diff.
+ ARCHIVER_MODE[diff-exclude] ?= "<file> <file> ..." # Lists files and directories to exclude from diff.
ARCHIVER_MODE[dumpdata] = "1" # Uses environment data.
ARCHIVER_MODE[recipe] = "1" # Uses recipe and include files.
Values the reader is expected to replace are written as though they were literal. "arch-gdb" reads like a command that exists, a Git SRC_URI example reads like a URL and a pair of revisions worth copying, and the git-config examples give an account name and address that are somebody else's. Put them in the angle brackets the manuals already use for the purpose. Two corrections go with them: the directory placeholder in the GDB example described itself at length rather than naming the thing, and the smtppass example carried a stray "=". Since git config takes a name and then a value, that "=" was the value, and the password behind it an argument git config reads as a pattern. AI-Generated: codex/claude-opus 5 (xhigh) Signed-off-by: Trevor Woerner <twoerner@gmail.com> --- changes in v3: - the DMARC From: header is left as it was; nothing in it is for the reader to replace - the git config name is written <firstname> <lastname> - the SRCREV values say they are commit SHAs - the SMTP server is a placeholder too, and the prose names smtp.gmail.com as the Google Mail value rather than the block changes in v2: - rebased on master-next; no other change --- .../contributor-guide/submit-changes.rst | 15 ++++++++------- documentation/dev-manual/debugging.rst | 8 ++++---- documentation/migration-guides/migration-5.2.rst | 16 ++++++++-------- documentation/ref-manual/devtool-reference.rst | 2 +- documentation/ref-manual/variables.rst | 2 +- 5 files changed, 22 insertions(+), 21 deletions(-)