branch: elpa/git-commit
commit 80959650b24a9c849b736234b56bc3d8aff2c0b9
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
Place comma after "e.g." and "i.e."
We already do this in Transient's documentation because that's what
is being done in Emacs' documentation and Transient is part of Emacs.
Let's be consistent even at the cost of making the English unhappy.
Also add a comma before "e.g." and "i.e.", if not inside parentheses,
which is the correct thing to do, regardless which style guide one
chooses to follow.
---
docs/RelNotes/2.11.0.txt | 2 +-
docs/RelNotes/2.3.0.txt | 4 +--
docs/RelNotes/2.7.0.txt | 2 +-
docs/RelNotes/2.90.0.org | 2 +-
docs/RelNotes/3.0.0.org | 4 +--
docs/RelNotes/3.3.0.org | 2 +-
docs/magit-section.org | 2 +-
docs/magit-section.texi | 2 +-
docs/magit.org | 94 ++++++++++++++++++++++++------------------------
docs/magit.texi | 94 ++++++++++++++++++++++++------------------------
lisp/git-commit.el | 6 ++--
lisp/git-rebase.el | 6 ++--
lisp/magit-base.el | 4 +--
lisp/magit-branch.el | 8 ++---
lisp/magit-diff.el | 12 +++----
lisp/magit-extras.el | 4 +--
lisp/magit-git.el | 6 ++--
lisp/magit-log.el | 4 +--
lisp/magit-margin.el | 2 +-
lisp/magit-mode.el | 2 +-
lisp/magit-process.el | 4 +--
lisp/magit-repos.el | 4 +--
lisp/magit-section.el | 4 +--
lisp/magit-sequence.el | 2 +-
lisp/magit-wip.el | 2 +-
lisp/magit-worktree.el | 2 +-
lisp/magit.el | 4 +--
27 files changed, 142 insertions(+), 142 deletions(-)
diff --git a/docs/RelNotes/2.11.0.txt b/docs/RelNotes/2.11.0.txt
index 1cd96944b3..d43b8b2c5d 100644
--- a/docs/RelNotes/2.11.0.txt
+++ b/docs/RelNotes/2.11.0.txt
@@ -98,7 +98,7 @@ Changes since v2.10.3
* The commands `magit-subtree-add', `magit-subtree-pull', and
`magit-subtree-push' now offer more completion candidates. #3081
-* The log buffer now shows the line range restriction (i.e. `-L'
+* The log buffer now shows the line range restriction (i.e., `-L'
argument) in its header. #3075
* Added new functions `magit-repolist-column-branches' and
diff --git a/docs/RelNotes/2.3.0.txt b/docs/RelNotes/2.3.0.txt
index fa7d8229df..ae09967ec7 100644
--- a/docs/RelNotes/2.3.0.txt
+++ b/docs/RelNotes/2.3.0.txt
@@ -14,7 +14,7 @@ Changes since v2.2.0
to perform an interactive rebase too. #2186
* Commands that perform an interactive rebase should no longer be used
- non-interactively (i.e. they should only be used as commands). #2187
+ non-interactively (i.e., they should only be used as commands). #2187
* Rebasing commands now can start with a root commit. Root commits
are detected automatically, so users don't have to use the `--root'
@@ -25,7 +25,7 @@ Changes since v2.2.0
* Added new option `magit-bury-buffer-function' to give users more
control over how Magit buffers are buried, replacing the old binary
option `magit-restore-window-configuration'. The default is still
- the same, i.e. `magit-restore-window-configuration' is used. #2193
+ the same, i.e., `magit-restore-window-configuration' is used. #2193
* Added new function `magit-mode-quit-window' as a simpler variant to
`magit-restore-window-configuration'. #2193
diff --git a/docs/RelNotes/2.7.0.txt b/docs/RelNotes/2.7.0.txt
index 310878a368..74c6ce980c 100644
--- a/docs/RelNotes/2.7.0.txt
+++ b/docs/RelNotes/2.7.0.txt
@@ -45,7 +45,7 @@ Changes since v2.6.0
blocking Emacs and allows handling password prompts.
* The command `magit-stage' learned to stage an untracked file while
- leaving its content unstaged (i.e. `git add --intent-to-add') when
+ leaving its content unstaged (i.e., `git add --intent-to-add') when
called with a prefix argument.
* The command `magit-reverse' learned to use `--reject' to ensure that
diff --git a/docs/RelNotes/2.90.0.org b/docs/RelNotes/2.90.0.org
index 671e0bcea7..a2695baea3 100644
--- a/docs/RelNotes/2.90.0.org
+++ b/docs/RelNotes/2.90.0.org
@@ -110,7 +110,7 @@ Also see https://emacsair.me/2018/11/08/magit-2.90.
- Added new option ~magit-status-initial-section~, which controls which
section point is placed on when a status buffer is created. The new
default is to place point on the section that follows the headers,
- i.e. the second section. This is quite flexible, you might want to
+ i.e., the second section. This is quite flexible, you might want to
read the doc-string. 87de83da8, #3562, #3518
- Added new commands ~magit-commit-absorb~ and ~magit-commit-absorb-popup~.
diff --git a/docs/RelNotes/3.0.0.org b/docs/RelNotes/3.0.0.org
index 0e384b4285..2c02efcada 100644
--- a/docs/RelNotes/3.0.0.org
+++ b/docs/RelNotes/3.0.0.org
@@ -463,7 +463,7 @@ This release also contains numerous other improvements.
replacement that never uses an outdated cache.
- ~magit-log-trace-definition~ didn't account for Git treating "-"
- differently from e.g. "_", leading to false-positives like
+ differently from, e.g., "_", leading to false-positives like
"foo-suffix" being considered a match for "foo".
- ~magit-log-trace-definition~ didn't do the escaping that Git expects
@@ -506,7 +506,7 @@ This release also contains numerous other improvements.
- ~magit-blame-echo~ was broken. #3720
- ~magit-rev-name~ sometimes returned ~nil~ even when it could return a
- name and it returned e.g. "origin/HEAD" instead of "origin/master".
+ name and it returned, e.g., "origin/HEAD" instead of "origin/master".
2042957a7, d500c442
- ~magit-insert-*-branch-header~ did not account for empty commit
diff --git a/docs/RelNotes/3.3.0.org b/docs/RelNotes/3.3.0.org
index c518a5f2ba..e1e9fe1675 100644
--- a/docs/RelNotes/3.3.0.org
+++ b/docs/RelNotes/3.3.0.org
@@ -104,7 +104,7 @@ Also see https://emacsair.me/2021/10/04/magit-3.3.
** Fixes since v3.2.0
- Make ~magit-branch-remote-head~ and ~magit-branch-current~ fall back
- to ~:inverse-video~ when the ~:box~ attribute isn't support, i.e. in
+ to ~:inverse-video~ when the ~:box~ attribute isn't support, i.e., in
a terminal. If this change does not have any effect for you then
your theme probably changes these faces and should stop doing so.
#4206
diff --git a/docs/magit-section.org b/docs/magit-section.org
index f5a6bf933f..a358bab991 100644
--- a/docs/magit-section.org
+++ b/docs/magit-section.org
@@ -63,7 +63,7 @@ source for suitable examples before asking me for help.
Thanks!
kludges, which are not available to other packages.
When optional HIDE is non-nil collapse the section body by
- default, i.e. when first creating the section, but not when
+ default, i.e., when first creating the section, but not when
refreshing the buffer. Else expand it by default. This can be
overwritten using ~magit-section-set-visibility-hook~. When a
section is recreated during a refresh, then the visibility of
diff --git a/docs/magit-section.texi b/docs/magit-section.texi
index e379b103e8..a018ce8be9 100644
--- a/docs/magit-section.texi
+++ b/docs/magit-section.texi
@@ -105,7 +105,7 @@ appropriate package prefix. This works due to some
undocumented
kludges, which are not available to other packages.
When optional HIDE is non-nil collapse the section body by
-default, i.e. when first creating the section, but not when
+default, i.e., when first creating the section, but not when
refreshing the buffer. Else expand it by default. This can be
overwritten using @code{magit-section-set-visibility-hook}. When a
section is recreated during a refresh, then the visibility of
diff --git a/docs/magit.org b/docs/magit.org
index c5a7e694f3..0b172e5e06 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -51,7 +51,7 @@ noisy, but, since sections are collapsible, it's not.
To stage or unstage a change one places the cursor on the change and
then types ~s~ or ~u~. The change can be a file or a hunk, or when the
-region is active (i.e. when there is a selection) several files or
+region is active (i.e., when there is a selection) several files or
hunks, or even just part of a hunk. The change or changes that these
commands - and many others - would act on are highlighted.
@@ -709,7 +709,7 @@ refresh explicitly.
By default Magit automatically reverts buffers that are visiting files
that are being tracked in a Git repository, after they have changed on
disk. When using Magit one often changes files on disk by running
-Git, i.e. "outside Emacs", making this a rather important feature.
+Git, i.e., "outside Emacs", making this a rather important feature.
For example, if you discard a change in the status buffer, then that
is done by running ~git apply --reverse ...~, and Emacs considers the
@@ -818,7 +818,7 @@ located in the ~magit~ group.
For the vast majority of users, automatically reverting file-visiting
buffers after they have changed on disk is harmless.
-If a buffer is modified (i.e. it contains changes that haven't been
+If a buffer is modified (i.e., it contains changes that haven't been
saved yet), then Emacs will refuse to automatically revert it. If
you save a previously modified buffer, then that results in what is
seen by Git as an uncommitted change. Git will then refuse to carry
@@ -1146,9 +1146,9 @@ certain sections can also be overwritten using the hook
Which sections are inserted into certain buffers is controlled with
hooks. This includes the status and the refs buffers. For other
-buffers, e.g. log and diff buffers, this is not possible. The command
-~magit-describe-section~ can be used to see which hook (if any) was
-responsible for inserting the section at point.
+buffers, e.g., log and diff buffers, this is not possible. The
+command ~magit-describe-section~ can be used to see which hook (if any)
+was responsible for inserting the section at point.
For buffers whose sections can be customized by the user, a hook
variable called ~magit-TYPE-sections-hook~ exists. This hook should be
@@ -1330,7 +1330,7 @@ that by default.
- User Option: magit-direct-use-buffer-arguments ::
This option controls whether certain commands, when invoked directly
- (i.e. not as the suffix of a transient prefix command), use the
+ (i.e., not as the suffix of a transient prefix command), use the
arguments that are currently active in the buffer that they are
about to update. The alternative is to use the default value for
these arguments, which might change the arguments that are used in
@@ -1415,7 +1415,7 @@ telling Magit to ask fewer questions.
- Applying changes:
- - ~discard~ Discarding one or more changes (i.e. hunks or the
+ - ~discard~ Discarding one or more changes (i.e., hunks or the
complete diff for a file) loses that change, obviously.
- ~reverse~ Reverting one or more changes can usually be undone by
@@ -1621,7 +1621,7 @@ begins and ends on the same line.
For a region to qualify as a Magit selection, it must begin in the
heading of one section and end in the heading of a sibling section.
Note that if the end of the region is at the very beginning of section
-heading (i.e. at the very beginning of a line) then that section is
+heading (i.e., at the very beginning of a line) then that section is
considered to be *inside* the selection.
This is not consistent with how the region is normally treated in
@@ -1785,8 +1785,8 @@ older Emacs release, set
~magit-section-show-context-menu-for-emacs<28~.
** Running Git
*** Viewing Git Output
-Magit runs Git either for side-effects (e.g. when pushing) or to get
-some value (e.g. the name of the current branch).
+Magit runs Git either for side-effects (e.g., when pushing) or to get
+some value (e.g., the name of the current branch).
When Git is run for side-effects, the process output is logged in a
per-repository log buffer, which can be consulted using the
@@ -2028,7 +2028,7 @@ the next two with manipulating and transferring it. Then
follows a
section about miscellaneous functionality, which cannot easily be fit
into this distinction.
-Of course other distinctions make sense too, e.g. Git's distinction
+Of course other distinctions make sense too, e.g., Git's distinction
between porcelain and plumbing commands, which for the most part is
equivalent to Emacs' distinction between interactive commands and
non-interactive functions. All of the sections mentioned before are
@@ -2037,7 +2037,7 @@ described later.
** Status Buffer
-While other Magit buffers contain e.g. one particular diff or one
+While other Magit buffers contain, e.g., one particular diff or one
particular log, the status buffer contains the diffs for staged and
unstaged changes, logs for unpushed and unpulled commits, lists of
stashes and untracked files, and information related to the current
@@ -2300,7 +2300,7 @@ The following functions can also be added to the above
hook:
Insert section showing unpulled commits.
Like ~magit-insert-unpulled-commits~ but prefix each commit
- that has not been applied yet (i.e. a commit with a patch-id
+ that has not been applied yet (i.e., a commit with a patch-id
not shared with any local commit) with "+", and all others
with "-".
@@ -2308,7 +2308,7 @@ The following functions can also be added to the above
hook:
Insert section showing unpushed commits.
Like ~magit-insert-unpushed-commits~ but prefix each commit
- which has not been applied to upstream yet (i.e. a commit with
+ which has not been applied to upstream yet (i.e., a commit with
a patch-id not shared with any upstream commit) with "+" and
all others with "-".
@@ -2997,7 +2997,7 @@ These reflog commands are available from the log
transient. See
Cherries are commits that haven't been applied upstream (yet), and are
usually visualized using a log. Each commit is prefixed with ~-~ if it
-has an equivalent in the upstream and ~+~ if it does not, i.e. if it is
+has an equivalent in the upstream and ~+~ if it does not, i.e., if it is
a cherry.
The command ~magit-cherry~ shows cherries for a single branch, but the
@@ -3977,14 +3977,14 @@ These commands can only be used when point is inside a
diff.
visited. The visited version depends on what changes the diff is
about.
- 1. If the diff shows uncommitted changes (i.e. staged or unstaged
- changes), then visit the file in the working tree (i.e. the
+ 1. If the diff shows uncommitted changes (i.e., staged or unstaged
+ changes), then visit the file in the working tree (i.e., the
same "real" file that ~find-file~ would visit. In all other
- cases visit a "blob" (i.e. the version of a file as stored
+ cases visit a "blob" (i.e., the version of a file as stored
in some commit).
2. If point is on a removed line, then visit the blob for the
- first parent of the commit that removed that line, i.e. the
+ first parent of the commit that removed that line, i.e., the
last commit where that line still exists.
3. If point is on an added or context line, then visit the blob
@@ -4527,7 +4527,7 @@ variants.
the change to be applied to the index as well.
With a prefix argument all apply variants attempt a 3-way merge when
-appropriate (i.e. when ~git apply~ is used internally).
+appropriate (i.e., when ~git apply~ is used internally).
** Committing
@@ -4755,8 +4755,8 @@ changes alongside those that have already been committed.
When reading the revision from the minibuffer, then it might not
be possible to guess the correct repository. When this command
- is called inside a repository (e.g. while composing a commit
- message), then that repository is used. Otherwise (e.g. while
+ is called inside a repository (e.g., while composing a commit
+ message), then that repository is used. Otherwise (e.g., while
composing an email) then the repository recorded for the top
element of the stack is used (even though we insert another
revision). If not called inside a repository and with an empty
@@ -5005,7 +5005,7 @@ also possible to set the push-remote or upstream while
pushing (see
The transient prefix command ~magit-branch~ is used to create and
checkout branches, and to make changes to existing branches. It is
-not used to fetch, pull, merge, rebase, or push branches, i.e. this
+not used to fetch, pull, merge, rebase, or push branches, i.e., this
command deals with branches themselves, not with the commits reachable
from them. Those features are available from separate transient
command.
@@ -5197,7 +5197,7 @@ The variables are described in [[*Branch Git Variables]].
them invalid as a branch name. Recommended characters to use
to trigger interpretation as a regexp are "*" and "^". Some
other characters which you might expect to be invalid, actually
- are not, e.g. ".+$" are all perfectly valid. More precisely,
+ are not, e.g., ".+$" are all perfectly valid. More precisely,
if ~git check-ref-format --branch STRING~ exits with a non-zero
status, then treat STRING as a regexp.
@@ -5224,7 +5224,7 @@ The variables are described in [[*Branch Git Variables]].
the upstream when branching a remote branch.
When creating a local branch from an ephemeral branch located on a
- remote, e.g. a feature or hotfix branch, then that remote branch
+ remote, e.g., a feature or hotfix branch, then that remote branch
should usually not be used as the upstream branch, since the
push-remote already allows accessing it and having both the upstream
and the push-remote reference the same related branch would be
@@ -5352,7 +5352,7 @@ These variables can be set from the transient prefix
command
- Variable: branch.NAME.description ::
This variable can be used to describe the branch named NAME. That
- description is used e.g. when turning the branch into a series of
+ description is used, e.g., when turning the branch into a series of
patches.
The following variables specify defaults which are used if the above
@@ -5938,8 +5938,8 @@ as the commits that still have to be applied.
The commits are split in two halves. When rebase stops at a commit,
either because the user has to deal with a conflict or because s/he
explicitly requested that rebase stops at that commit, then point is
-placed on the commit that separates the two groups, i.e. on ~HEAD~. The
-commits above it have not been applied yet, while the ~HEAD~ and the
+placed on the commit that separates the two groups, i.e., on ~HEAD~.
+The commits above it have not been applied yet, while the ~HEAD~ and the
commits below it have already been applied. In between these two
groups of applied and yet-to-be applied commits, there sometimes is a
commit which has been dropped.
@@ -5961,14 +5961,14 @@ The following colors are used:
- The blue commit is the ~HEAD~ commit.
- The green commit is the commit the rebase sequence stopped at. If
- this is the same commit as ~HEAD~ (e.g. because you haven't done
+ this is the same commit as ~HEAD~ (e.g., because you haven't done
anything yet after rebase stopped at the commit, then this commit is
shown in blue, not green). There can only be a green *and* a blue
commit at the same time, if you create one or more new commits after
rebase stops at a commit.
- Red commits have been dropped. They are shown for reference only,
- e.g. to make it easier to diff.
+ e.g., to make it easier to diff.
Of course these colors are subject to the color-theme in use.
@@ -6095,7 +6095,7 @@ commits which have already been applied.
[fn:patch-id] The patch-id is a hash of the /changes/ introduced by a
commit. It differs from the hash of the commit itself, which is a
-hash of the result of applying that change (i.e. the resulting trees
+hash of the result of applying that change (i.e., the resulting trees
and blobs) as well as author and committer information, the commit
message, and the hashes of the parents of the commit. The patch-id
hash on the other hand is created only from the added and removed
@@ -7302,7 +7302,7 @@ nothing is saved before the first commit has been
created).
Two separate work-in-progress references are used to track the state
of the index and of the working tree: ~refs/wip/index/<branchref>~ and
~refs/wip/wtree/<branchref>~, where ~<branchref>~ is the full ref of the
-current branch, e.g. ~refs/heads/master~. When the ~HEAD~ is detached
+current branch, e.g., ~refs/heads/master~. When the ~HEAD~ is detached
then ~HEAD~ is used in place of ~<branchref>~.
Checking out another branch (or detaching ~HEAD~) causes the use of
@@ -7311,7 +7311,7 @@ different wip refs for subsequent changes.
- User Option: magit-wip-mode ::
When this mode is enabled, then uncommitted changes are committed
- to dedicated work-in-progress refs whenever appropriate (i.e. when
+ to dedicated work-in-progress refs whenever appropriate (i.e., when
dataloss would be a possibility otherwise).
Setting this variable directly does not take effect; either use the
@@ -7465,7 +7465,7 @@ functions.
- User Option: magit-wip-after-apply-mode ::
- When this mode is enabled, then applying (i.e. staging, unstaging,
+ When this mode is enabled, then applying (i.e., staging, unstaging,
discarding, reversing, and regularly applying) a change to a file
tracked in a Git repository causes its current state to be committed
to the index and/or working tree wip refs for the current branch.
@@ -7747,7 +7747,7 @@ repository:
If you want to apply the same settings to several, but not all,
repositories then keeping the repository-local config files in sync
would quickly become annoying. To avoid that you can create config
-files for certain classes of repositories (e.g. "huge repositories")
+files for certain classes of repositories (e.g., "huge repositories")
and then include those files in the per-repository config files.
For example:
@@ -8186,7 +8186,7 @@ commands that have side-effects, but that should be
avoided.
the call and ensures unix eol conversion.
If an error occurs when using one of the above functions, then that
-is usually due to a bug, i.e. using an argument which is not
+is usually due to a bug, i.e., using an argument which is not
actually supported. Such errors are usually not reported, but when
they occur we need to be able to debug them.
@@ -8218,7 +8218,7 @@ buffer, which can be shown using ~$~ from a Magit buffer
or ~M-x
magit-process~ elsewhere.
These functions can have an effect in two distinct ways. Firstly,
-running git may change something, i.e. create or push a new commit.
+running git may change something, i.e., create or push a new commit.
Secondly, that change may require that Magit buffers are refreshed to
reflect the changed state of the repository. But refreshing isn't
always desirable, so only some of these functions do perform such a
@@ -8362,7 +8362,7 @@ And now for the asynchronous variants.
required when acting on the section.
When optional HIDE is non-nil collapse the section body by default,
- i.e. when first creating the section, but not when refreshing the
+ i.e., when first creating the section, but not when refreshing the
buffer. Otherwise, expand it by default. This can be overwritten using
~magit-section-set-visibility-hook~. When a section is recreated
during a refresh, then the visibility of predecessor is inherited
@@ -8589,7 +8589,7 @@ For diff related sections a few additional tools exist.
ignoring the sections selected by the region. Otherwise return the
scope of the current section, or if the region is active and selects
a valid group of diff related sections, the type of these sections,
- i.e. ~hunks~ or ~files~. If SECTION (or if the current section that
+ i.e., ~hunks~ or ~files~. If SECTION (or if the current section that
is nil) is a ~hunk~ section and the region starts and ends inside
the body of a that section, then the type is ~region~.
@@ -8719,7 +8719,7 @@ select lines within a single hunk section. In all other
cases, the
section is considered invalid and Magit won't act on it. But such
invalid sections happen, either because the user has not moved point
enough yet to make it valid or because she wants to use a non-magit
-command to act on the region, e.g. ~kill-region~.
+command to act on the region, e.g., ~kill-region~.
So using the regular ~region~ face for invalid sections is a feature. It
tells the user that Magit won't be able to act on it. It's acceptable
@@ -8749,7 +8749,7 @@ complications, and there are already enough we cannot get
around.
always be bold, but only for sections that have subsections).
When there is a valid region selecting diff-related sibling sections,
-i.e. multiple files or hunks, then the bodies of all these sections
+i.e., multiple files or hunks, then the bodies of all these sections
use the respective highlight faces, but additionally the headings
instead use one of the faces ~magit-diff-file-heading-selection~ or
~magit-diff-hunk-heading-selection~. These faces have to be different
@@ -8774,7 +8774,7 @@ same for the removed lines, context lines, lines added by
us, and
lines added by them. Also make sure the respective added, removed,
and context faces use approximately the same saturation for both the
highlighted and unhighlighted variants. Also make sure the file and
-diff headings work nicely with context lines (e.g. make them look
+diff headings work nicely with context lines (e.g., make them look
different). Line faces should set both the foreground and the
background color. For example, for added lines use two different
greens.
@@ -8807,7 +8807,7 @@ all.
:END:
The next two nodes lists frequently asked questions. For a list of
-frequently *and recently* asked questions, i.e. questions that haven't
+frequently *and recently* asked questions, i.e., questions that haven't
made it into the manual yet, see
https://github.com/magit/magit/wiki/FAQ.
@@ -9084,9 +9084,9 @@ Magit used to use Magit-Popup to implement the transient
popup menus.
Now it used Transient instead, which is Magit-Popup's successor.
In the older Magit-Popup menus, it was possible to save user settings
-(e.g. setting the gpg signing key for commits) by using ~C-c C-c~ in the
-popup buffer. This would dismiss the popup, but save the settings as
-the defaults for future popups.
+(e.g., setting the gpg signing key for commits) by using ~C-c C-c~ in
+the popup buffer. This would dismiss the popup, but save the settings
+as the defaults for future popups.
When switching to Transient menus, this functionality is now available
via ~C-x C-s~ instead; the ~C-x~ prefix has other options as well when
diff --git a/docs/magit.texi b/docs/magit.texi
index 6c02d8adff..a242f7ea01 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -367,7 +367,7 @@ noisy, but, since sections are collapsible, it's not.
To stage or unstage a change one places the cursor on the change and
then types @code{s} or @code{u}. The change can be a file or a hunk, or when
the
-region is active (i.e. when there is a selection) several files or
+region is active (i.e., when there is a selection) several files or
hunks, or even just part of a hunk. The change or changes that these
commands - and many others - would act on are highlighted.
@@ -1086,7 +1086,7 @@ intervention. If it is @code{t} then the user has to
confirm each save.
By default Magit automatically reverts buffers that are visiting files
that are being tracked in a Git repository, after they have changed on
disk. When using Magit one often changes files on disk by running
-Git, i.e. "outside Emacs", making this a rather important feature.
+Git, i.e., "outside Emacs", making this a rather important feature.
For example, if you discard a change in the status buffer, then that
is done by running @code{git apply --reverse ...}, and Emacs considers the
@@ -1197,7 +1197,7 @@ located in the @code{magit} group.
For the vast majority of users, automatically reverting file-visiting
buffers after they have changed on disk is harmless.
-If a buffer is modified (i.e. it contains changes that haven't been
+If a buffer is modified (i.e., it contains changes that haven't been
saved yet), then Emacs will refuse to automatically revert it. If
you save a previously modified buffer, then that results in what is
seen by Git as an uncommitted change. Git will then refuse to carry
@@ -1568,9 +1568,9 @@ doing so is kinda ugly.
Which sections are inserted into certain buffers is controlled with
hooks. This includes the status and the refs buffers. For other
-buffers, e.g. log and diff buffers, this is not possible. The command
-@code{magit-describe-section} can be used to see which hook (if any) was
-responsible for inserting the section at point.
+buffers, e.g., log and diff buffers, this is not possible. The
+command @code{magit-describe-section} can be used to see which hook (if any)
+was responsible for inserting the section at point.
For buffers whose sections can be customized by the user, a hook
variable called @code{magit-TYPE-sections-hook} exists. This hook should be
@@ -1761,7 +1761,7 @@ by this option.
@defopt magit-direct-use-buffer-arguments
This option controls whether certain commands, when invoked directly
-(i.e. not as the suffix of a transient prefix command), use the
+(i.e., not as the suffix of a transient prefix command), use the
arguments that are currently active in the buffer that they are
about to update. The alternative is to use the default value for
these arguments, which might change the arguments that are used in
@@ -1875,7 +1875,7 @@ Applying changes:
@itemize
@item
-@code{discard} Discarding one or more changes (i.e. hunks or the
+@code{discard} Discarding one or more changes (i.e., hunks or the
complete diff for a file) loses that change, obviously.
@item
@@ -2129,7 +2129,7 @@ begins and ends on the same line.
For a region to qualify as a Magit selection, it must begin in the
heading of one section and end in the heading of a sibling section.
Note that if the end of the region is at the very beginning of section
-heading (i.e. at the very beginning of a line) then that section is
+heading (i.e., at the very beginning of a line) then that section is
considered to be @strong{inside} the selection.
This is not consistent with how the region is normally treated in
@@ -2316,8 +2316,8 @@ older Emacs release, set
@code{magit-section-show-context-menu-for-emacs<28}.
@node Viewing Git Output
@subsection Viewing Git Output
-Magit runs Git either for side-effects (e.g. when pushing) or to get
-some value (e.g. the name of the current branch).
+Magit runs Git either for side-effects (e.g., when pushing) or to get
+some value (e.g., the name of the current branch).
When Git is run for side-effects, the process output is logged in a
per-repository log buffer, which can be consulted using the
@@ -2598,7 +2598,7 @@ the next two with manipulating and transferring it. Then
follows a
section about miscellaneous functionality, which cannot easily be fit
into this distinction.
-Of course other distinctions make sense too, e.g. Git's distinction
+Of course other distinctions make sense too, e.g., Git's distinction
between porcelain and plumbing commands, which for the most part is
equivalent to Emacs' distinction between interactive commands and
non-interactive functions. All of the sections mentioned before are
@@ -2620,7 +2620,7 @@ described later.
@node Status Buffer
@section Status Buffer
-While other Magit buffers contain e.g. one particular diff or one
+While other Magit buffers contain, e.g., one particular diff or one
particular log, the status buffer contains the diffs for staged and
unstaged changes, logs for unpushed and unpulled commits, lists of
stashes and untracked files, and information related to the current
@@ -2902,7 +2902,7 @@ unpulled commits) show.
@defun magit-insert-unpulled-cherries
Insert section showing unpulled commits.
Like @code{magit-insert-unpulled-commits} but prefix each commit
-that has not been applied yet (i.e. a commit with a patch-id
+that has not been applied yet (i.e., a commit with a patch-id
not shared with any local commit) with "+", and all others
with "-".
@end defun
@@ -2910,7 +2910,7 @@ with "-".
@defun magit-insert-unpushed-cherries
Insert section showing unpushed commits.
Like @code{magit-insert-unpushed-commits} but prefix each commit
-which has not been applied to upstream yet (i.e. a commit with
+which has not been applied to upstream yet (i.e., a commit with
a patch-id not shared with any upstream commit) with "+" and
all others with "-".
@end defun
@@ -3729,7 +3729,7 @@ is shown, then this specifies how much space is used to
do so.
Cherries are commits that haven't been applied upstream (yet), and are
usually visualized using a log. Each commit is prefixed with @code{-} if it
-has an equivalent in the upstream and @code{+} if it does not, i.e. if it is
+has an equivalent in the upstream and @code{+} if it does not, i.e., if it is
a cherry.
The command @code{magit-cherry} shows cherries for a single branch, but the
@@ -4937,15 +4937,15 @@ about.
@enumerate
@item
-If the diff shows uncommitted changes (i.e. staged or unstaged
-changes), then visit the file in the working tree (i.e. the
+If the diff shows uncommitted changes (i.e., staged or unstaged
+changes), then visit the file in the working tree (i.e., the
same "real" file that @code{find-file} would visit. In all other
-cases visit a "blob" (i.e. the version of a file as stored
+cases visit a "blob" (i.e., the version of a file as stored
in some commit).
@item
If point is on a removed line, then visit the blob for the
-first parent of the commit that removed that line, i.e. the
+first parent of the commit that removed that line, i.e., the
last commit where that line still exists.
@item
@@ -5618,7 +5618,7 @@ the change to be applied to the index as well.
@end table
With a prefix argument all apply variants attempt a 3-way merge when
-appropriate (i.e. when @code{git apply} is used internally).
+appropriate (i.e., when @code{git apply} is used internally).
@node Committing
@section Committing
@@ -5899,8 +5899,8 @@ stack.
When reading the revision from the minibuffer, then it might not
be possible to guess the correct repository. When this command
-is called inside a repository (e.g. while composing a commit
-message), then that repository is used. Otherwise (e.g. while
+is called inside a repository (e.g., while composing a commit
+message), then that repository is used. Otherwise (e.g., while
composing an email) then the repository recorded for the top
element of the stack is used (even though we insert another
revision). If not called inside a repository and with an empty
@@ -6174,7 +6174,7 @@ also possible to set the push-remote or upstream while
pushing (see
The transient prefix command @code{magit-branch} is used to create and
checkout branches, and to make changes to existing branches. It is
-not used to fetch, pull, merge, rebase, or push branches, i.e. this
+not used to fetch, pull, merge, rebase, or push branches, i.e., this
command deals with branches themselves, not with the commits reachable
from them. Those features are available from separate transient
command.
@@ -6390,7 +6390,7 @@ have to match exactly unless they contain a character
that makes
them invalid as a branch name. Recommended characters to use
to trigger interpretation as a regexp are "*" and "^". Some
other characters which you might expect to be invalid, actually
-are not, e.g. ".+$" are all perfectly valid. More precisely,
+are not, e.g., ".+$" are all perfectly valid. More precisely,
if @code{git check-ref-format --branch STRING} exits with a non-zero
status, then treat STRING as a regexp.
@@ -6417,7 +6417,7 @@ The value of this option is an alist of branches to be
used as
the upstream when branching a remote branch.
When creating a local branch from an ephemeral branch located on a
-remote, e.g. a feature or hotfix branch, then that remote branch
+remote, e.g., a feature or hotfix branch, then that remote branch
should usually not be used as the upstream branch, since the
push-remote already allows accessing it and having both the upstream
and the push-remote reference the same related branch would be
@@ -6551,7 +6551,7 @@ is undefined.
@defvar branch.NAME.description
This variable can be used to describe the branch named NAME@. That
-description is used e.g. when turning the branch into a series of
+description is used, e.g., when turning the branch into a series of
patches.
@end defvar
@@ -7288,8 +7288,8 @@ as the commits that still have to be applied.
The commits are split in two halves. When rebase stops at a commit,
either because the user has to deal with a conflict or because s/he
explicitly requested that rebase stops at that commit, then point is
-placed on the commit that separates the two groups, i.e. on @code{HEAD}. The
-commits above it have not been applied yet, while the @code{HEAD} and the
+placed on the commit that separates the two groups, i.e., on @code{HEAD}.
+The commits above it have not been applied yet, while the @code{HEAD} and the
commits below it have already been applied. In between these two
groups of applied and yet-to-be applied commits, there sometimes is a
commit which has been dropped.
@@ -7317,7 +7317,7 @@ The blue commit is the @code{HEAD} commit.
@item
The green commit is the commit the rebase sequence stopped at. If
-this is the same commit as @code{HEAD} (e.g. because you haven't done
+this is the same commit as @code{HEAD} (e.g., because you haven't done
anything yet after rebase stopped at the commit, then this commit is
shown in blue, not green). There can only be a green @strong{and} a blue
commit at the same time, if you create one or more new commits after
@@ -7325,7 +7325,7 @@ rebase stops at a commit.
@item
Red commits have been dropped. They are shown for reference only,
-e.g. to make it easier to diff.
+e.g., to make it easier to diff.
@end itemize
Of course these colors are subject to the color-theme in use.
@@ -7364,7 +7364,7 @@ are in some way related to the commit at which rebase
stopped.
To determine whether a commit is related to the stopped-at commit
their hashes, trees and patch-ids @footnote{The patch-id is a hash of the
@emph{changes} introduced by a
commit. It differs from the hash of the commit itself, which is a
-hash of the result of applying that change (i.e. the resulting trees
+hash of the result of applying that change (i.e., the resulting trees
and blobs) as well as author and committer information, the commit
message, and the hashes of the parents of the commit. The patch-id
hash on the other hand is created only from the added and removed
@@ -9122,7 +9122,7 @@ nothing is saved before the first commit has been
created).
Two separate work-in-progress references are used to track the state
of the index and of the working tree: @code{refs/wip/index/<branchref>} and
@code{refs/wip/wtree/<branchref>}, where @code{<branchref>} is the full ref of
the
-current branch, e.g. @code{refs/heads/master}. When the @code{HEAD} is
detached
+current branch, e.g., @code{refs/heads/master}. When the @code{HEAD} is
detached
then @code{HEAD} is used in place of @code{<branchref>}.
Checking out another branch (or detaching @code{HEAD}) causes the use of
@@ -9130,7 +9130,7 @@ different wip refs for subsequent changes.
@defopt magit-wip-mode
When this mode is enabled, then uncommitted changes are committed
-to dedicated work-in-progress refs whenever appropriate (i.e. when
+to dedicated work-in-progress refs whenever appropriate (i.e., when
dataloss would be a possibility otherwise).
Setting this variable directly does not take effect; either use the
@@ -9296,7 +9296,7 @@ to the working tree wip ref for the current branch.
@end defopt
@defopt magit-wip-after-apply-mode
-When this mode is enabled, then applying (i.e. staging, unstaging,
+When this mode is enabled, then applying (i.e., staging, unstaging,
discarding, reversing, and regularly applying) a change to a file
tracked in a Git repository causes its current state to be committed
to the index and/or working tree wip refs for the current branch.
@@ -9632,7 +9632,7 @@ repository. It is only intended for use in
@code{.dir-locals.el} and
If you want to apply the same settings to several, but not all,
repositories then keeping the repository-local config files in sync
would quickly become annoying. To avoid that you can create config
-files for certain classes of repositories (e.g. "huge repositories")
+files for certain classes of repositories (e.g., "huge repositories")
and then include those files in the per-repository config files.
For example:
@@ -10098,7 +10098,7 @@ the call and ensures unix eol conversion.
@end defun
If an error occurs when using one of the above functions, then that
-is usually due to a bug, i.e. using an argument which is not
+is usually due to a bug, i.e., using an argument which is not
actually supported. Such errors are usually not reported, but when
they occur we need to be able to debug them.
@@ -10131,7 +10131,7 @@ buffer, which can be shown using @code{$} from a Magit
buffer or @code{M-x
magit-process} elsewhere.
These functions can have an effect in two distinct ways. Firstly,
-running git may change something, i.e. create or push a new commit.
+running git may change something, i.e., create or push a new commit.
Secondly, that change may require that Magit buffers are refreshed to
reflect the changed state of the repository. But refreshing isn't
always desirable, so only some of these functions do perform such a
@@ -10283,7 +10283,7 @@ Optional VALUE is the value of the section, usually a
string that is
required when acting on the section.
When optional HIDE is non-nil collapse the section body by default,
-i.e. when first creating the section, but not when refreshing the
+i.e., when first creating the section, but not when refreshing the
buffer. Otherwise, expand it by default. This can be overwritten using
@code{magit-section-set-visibility-hook}. When a section is recreated
during a refresh, then the visibility of predecessor is inherited
@@ -10520,7 +10520,7 @@ If optional SECTION is non-nil, then return the scope
of that,
ignoring the sections selected by the region. Otherwise return the
scope of the current section, or if the region is active and selects
a valid group of diff related sections, the type of these sections,
-i.e. @code{hunks} or @code{files}. If SECTION (or if the current section that
+i.e., @code{hunks} or @code{files}. If SECTION (or if the current section that
is nil) is a @code{hunk} section and the region starts and ends inside
the body of a that section, then the type is @code{region}.
@@ -10658,7 +10658,7 @@ select lines within a single hunk section. In all
other cases, the
section is considered invalid and Magit won't act on it. But such
invalid sections happen, either because the user has not moved point
enough yet to make it valid or because she wants to use a non-magit
-command to act on the region, e.g. @code{kill-region}.
+command to act on the region, e.g., @code{kill-region}.
So using the regular @code{region} face for invalid sections is a feature. It
tells the user that Magit won't be able to act on it. It's acceptable
@@ -10688,7 +10688,7 @@ complications, and there are already enough we cannot
get around.
always be bold, but only for sections that have subsections).
When there is a valid region selecting diff-related sibling sections,
-i.e. multiple files or hunks, then the bodies of all these sections
+i.e., multiple files or hunks, then the bodies of all these sections
use the respective highlight faces, but additionally the headings
instead use one of the faces @code{magit-diff-file-heading-selection} or
@code{magit-diff-hunk-heading-selection}. These faces have to be different
@@ -10713,7 +10713,7 @@ same for the removed lines, context lines, lines added
by us, and
lines added by them. Also make sure the respective added, removed,
and context faces use approximately the same saturation for both the
highlighted and unhighlighted variants. Also make sure the file and
-diff headings work nicely with context lines (e.g. make them look
+diff headings work nicely with context lines (e.g., make them look
different). Line faces should set both the foreground and the
background color. For example, for added lines use two different
greens.
@@ -10744,7 +10744,7 @@ all.
@appendix FAQ
The next two nodes lists frequently asked questions. For a list of
-frequently @strong{and recently} asked questions, i.e. questions that haven't
+frequently @strong{and recently} asked questions, i.e., questions that haven't
made it into the manual yet, see
@uref{https://github.com/magit/magit/wiki/FAQ}.
@@ -11073,9 +11073,9 @@ Magit used to use Magit-Popup to implement the
transient popup menus.
Now it used Transient instead, which is Magit-Popup's successor.
In the older Magit-Popup menus, it was possible to save user settings
-(e.g. setting the gpg signing key for commits) by using @code{C-c C-c} in the
-popup buffer. This would dismiss the popup, but save the settings as
-the defaults for future popups.
+(e.g., setting the gpg signing key for commits) by using @code{C-c C-c} in
+the popup buffer. This would dismiss the popup, but save the settings
+as the defaults for future popups.
When switching to Transient menus, this functionality is now available
via @code{C-x C-s} instead; the @code{C-x} prefix has other options as well
when
diff --git a/lisp/git-commit.el b/lisp/git-commit.el
index 8da55cac02..59f4fd08f5 100644
--- a/lisp/git-commit.el
+++ b/lisp/git-commit.el
@@ -45,7 +45,7 @@
;; actually passing it a message. Git then invokes the `$GIT_EDITOR'
;; (or if that is undefined `$EDITOR') asking the user to provide the
;; message by editing the file ".git/COMMIT_EDITMSG" (or another file
-;; in that directory, e.g. ".git/MERGE_MSG" for merge commits).
+;; in that directory, e.g., ".git/MERGE_MSG" for merge commits).
;; When `global-git-commit-mode' is enabled, which it is by default,
;; then opening such a file causes the features described below, to
@@ -76,7 +76,7 @@
;; Aborting the commit does not cause the message to be lost, but
;; relying solely on the file not being tampered with is risky. This
;; package additionally stores all aborted messages for the duration
-;; of the current session (i.e. until you close Emacs). To get back
+;; of the current session (i.e., until you close Emacs). To get back
;; an aborted message use M-p and M-n while editing a message.
;;
;; M-p Replace the buffer contents with the previous message
@@ -1129,7 +1129,7 @@ Added to `font-lock-extend-region-functions'."
(define-derived-mode git-commit-elisp-text-mode text-mode "ElText"
"Major mode for editing commit messages of elisp projects.
This is intended for use as `git-commit-major-mode' for projects
-that expect `symbols' to look like this. I.e. like they look in
+that expect `symbols' to look like this. I.e., like they look in
Elisp doc-strings, including this one. Unlike in doc-strings,
\"strings\" also look different than the other text."
(setq font-lock-defaults '(git-commit-elisp-text-mode-keywords)))
diff --git a/lisp/git-rebase.el b/lisp/git-rebase.el
index b3a219d70b..40d5a32652 100644
--- a/lisp/git-rebase.el
+++ b/lisp/git-rebase.el
@@ -25,7 +25,7 @@
;; This package assists the user in editing the list of commits to be
;; rewritten during an interactive rebase.
-;; When the user initiates an interactive rebase, e.g. using "r e" in
+;; When the user initiates an interactive rebase, e.g., using "r e" in
;; a Magit buffer or on the command line using "git rebase -i REV",
;; Git invokes the `$GIT_SEQUENCE_EDITOR' (or if that is undefined
;; `$GIT_EDITOR' or even `$EDITOR') letting the user rearrange, drop,
@@ -36,7 +36,7 @@
;; providing the following commands:
;;
;; C-c C-c Tell Git to make it happen.
-;; C-c C-k Tell Git that you changed your mind, i.e. abort.
+;; C-c C-k Tell Git that you changed your mind, i.e., abort.
;;
;; p Move point to previous line.
;; n Move point to next line.
@@ -199,7 +199,7 @@
(defvar git-rebase-command-descriptions
'((with-editor-finish . "tell Git to make it happen")
- (with-editor-cancel . "tell Git that you changed your mind, i.e.
abort")
+ (with-editor-cancel . "tell Git that you changed your mind,
i.e., abort")
(git-rebase-backward-line . "move point to previous line")
(forward-line . "move point to next line")
(git-rebase-move-line-up . "move the commit at point up")
diff --git a/lisp/magit-base.el b/lisp/magit-base.el
index 9549c8828a..d0a6172727 100644
--- a/lisp/magit-base.el
+++ b/lisp/magit-base.el
@@ -183,7 +183,7 @@ so we don't use the command names but more generic symbols.
Applying changes:
- `discard' Discarding one or more changes (i.e. hunks or the
+ `discard' Discarding one or more changes (i.e., hunks or the
complete diff for a file) loses that change, obviously.
`reverse' Reverting one or more changes can usually be undone
@@ -974,7 +974,7 @@ with the text area."
This combines the benefits of `buffer-string', `buffer-substring'
and `buffer-substring-no-properties' into one function that is
-not as painful to use as the latter. I.e. you can write
+not as painful to use as the latter. I.e., you can write
(magit--buffer-string)
instead of
(buffer-substring-no-properties (point-min)
diff --git a/lisp/magit-branch.el b/lisp/magit-branch.el
index a55c644498..98b66e3647 100644
--- a/lisp/magit-branch.el
+++ b/lisp/magit-branch.el
@@ -77,7 +77,7 @@ have to match exactly unless they contain a character that
makes
them invalid as a branch name. Recommended characters to use
to trigger interpretation as a regexp are \"*\" and \"^\". Some
other characters which you might expect to be invalid, actually
-are not, e.g. \".+$\" are all perfectly valid. More precisely,
+are not, e.g., \".+$\" are all perfectly valid. More precisely,
if `git check-ref-format --branch STRING' exits with a non-zero
status, then treat STRING as a regexp.
@@ -101,7 +101,7 @@ prefer the former, then you should add branches such as
\"master\",
"Alist of upstreams to be used when branching from remote branches.
When creating a local branch from an ephemeral branch located
-on a remote, e.g. a feature or hotfix branch, then that remote
+on a remote, e.g., a feature or hotfix branch, then that remote
branch should usually not be used as the upstream branch, since
the push-remote already allows accessing it and having both the
upstream and the push-remote reference the same related branch
@@ -775,11 +775,11 @@ the remote."
(not new-target)
(magit-y-or-n-p (format "Also rename %S to %S on \"%s\""
old new remote)))
- ;; Rename on (i.e. within) the remote, but only if the
+ ;; Rename on (i.e., within) the remote, but only if the
;; destination ref doesn't exist yet. If that ref already
;; exists, then it probably is of some value and we better
;; not touch it. Ignore what the local ref points at,
- ;; i.e. if the local and the remote ref didn't point at
+ ;; i.e., if the local and the remote ref didn't point at
;; the same commit before the rename then keep it that way.
(magit-call-git "push" "-v" remote
(format "%s:refs/heads/%s" old-target new)
diff --git a/lisp/magit-diff.el b/lisp/magit-diff.el
index 99bb21db2e..f1df583bf5 100644
--- a/lisp/magit-diff.el
+++ b/lisp/magit-diff.el
@@ -1534,14 +1534,14 @@ Visit the worktree version of the appropriate file.
The location
of point inside the diff determines which file is being visited.
The visited version depends on what changes the diff is about.
-1. If the diff shows uncommitted changes (i.e. stage or unstaged
- changes), then visit the file in the working tree (i.e. the
+1. If the diff shows uncommitted changes (i.e., stage or unstaged
+ changes), then visit the file in the working tree (i.e., the
same \"real\" file that `find-file' would visit. In all other
- cases visit a \"blob\" (i.e. the version of a file as stored
+ cases visit a \"blob\" (i.e., the version of a file as stored
in some commit).
2. If point is on a removed line, then visit the blob for the
- first parent of the commit that removed that line, i.e. the
+ first parent of the commit that removed that line, i.e., the
last commit where that line still exists.
3. If point is on an added or context line, then visit the blob
@@ -3054,7 +3054,7 @@ Do not confuse this with `magit-diff-scope' (which see)."
((equal const "--cached")
(if (magit-rev-head-p range)
'staged
- 'undefined)) ; i.e. committed and staged
+ 'undefined)) ; i.e., committed and staged
(t 'committed))))
((derived-mode-p 'magit-status-mode)
(let ((stype (oref it type)))
@@ -3091,7 +3091,7 @@ If optional SECTION is non-nil, then return the scope of
that,
ignoring the sections selected by the region. Otherwise return
the scope of the current section, or if the region is active and
selects a valid group of diff related sections, the type of these
-sections, i.e. `hunks' or `files'. If SECTION, or if that is nil
+sections, i.e., `hunks' or `files'. If SECTION, or if that is nil
the current section, is a `hunk' section; and the region region
starts and ends inside the body of a that section, then the type
is `region'. If the region is empty after a mouse click, then
diff --git a/lisp/magit-extras.el b/lisp/magit-extras.el
index 880ef39cdb..a879520954 100644
--- a/lisp/magit-extras.el
+++ b/lisp/magit-extras.el
@@ -684,8 +684,8 @@ stack.
When reading the revision from the minibuffer, then it might not
be possible to guess the correct repository. When this command
-is called inside a repository (e.g. while composing a commit
-message), then that repository is used. Otherwise (e.g. while
+is called inside a repository (e.g., while composing a commit
+message), then that repository is used. Otherwise (e.g., while
composing an email) then the repository recorded for the top
element of the stack is used (even though we insert another
revision). If not called inside a repository and with an empty
diff --git a/lisp/magit-git.el b/lisp/magit-git.el
index a97636f8bc..6f2edf5a2c 100644
--- a/lisp/magit-git.el
+++ b/lisp/magit-git.el
@@ -902,7 +902,7 @@ to another directory, while another buffer was current.
When optional DIRECTORY is non-nil then return the toplevel for
that directory instead of the one for `default-directory'.
-Try to respect the option `find-file-visit-truename', i.e. when
+Try to respect the option `find-file-visit-truename', i.e., when
the value of that option is nil, then avoid needlessly returning
the truename. When a symlink to a sub-directory of the working
tree is involved, or when called from within a sub-directory of
@@ -1713,7 +1713,7 @@ Otherwise UPSTREAM has to be an existing branch."
It BRANCH is nil, then return the upstream of the current branch,
if any, nil otherwise. If the upstream is not configured, the
configured remote is an url, or the named branch does not exist,
-then return nil. I.e. return an existing local or
+then return nil. I.e., return an existing local or
remote-tracking branch ref."
(and-let* ((branch (or branch (magit-get-current-branch))))
(magit-ref-fullname (concat branch "@{upstream}"))))
@@ -1723,7 +1723,7 @@ remote-tracking branch ref."
It BRANCH is nil, then return the upstream of the current branch
if any, nil otherwise. If the upstream is not configured, the
configured remote is an url, or the named branch does not exist,
-then return nil. I.e. return the name of an existing local or
+then return nil. I.e., return the name of an existing local or
remote-tracking branch. The returned string is colorized
according to the branch type."
(magit--with-refresh-cache
diff --git a/lisp/magit-log.el b/lisp/magit-log.el
index 21c41d37a5..c0010c20a5 100644
--- a/lisp/magit-log.el
+++ b/lisp/magit-log.el
@@ -1907,7 +1907,7 @@ Show the last `magit-log-section-commit-count' commits."
(defun magit-insert-unpulled-cherries ()
"Insert section showing unpulled commits.
Like `magit-insert-unpulled-from-upstream' but prefix each commit
-which has not been applied yet (i.e. a commit with a patch-id
+which has not been applied yet (i.e., a commit with a patch-id
not shared with any local commit) with \"+\", and all others with
\"-\"."
(when (magit-git-success "rev-parse" "@{upstream}")
@@ -1920,7 +1920,7 @@ not shared with any local commit) with \"+\", and all
others with
(defun magit-insert-unpushed-cherries ()
"Insert section showing unpushed commits.
Like `magit-insert-unpushed-to-upstream' but prefix each commit
-which has not been applied to upstream yet (i.e. a commit with
+which has not been applied to upstream yet (i.e., a commit with
a patch-id not shared with any upstream commit) with \"+\", and
all others with \"-\"."
(when (magit-git-success "rev-parse" "@{upstream}")
diff --git a/lisp/magit-margin.el b/lisp/magit-margin.el
index 20688b43d4..0748fa38e0 100644
--- a/lisp/magit-margin.el
+++ b/lisp/magit-margin.el
@@ -44,7 +44,7 @@ options to the same values by customizing `magit-log-margin'
values for the other options will default to what you have set
for that variable. Likewise if you set `magit-log-margin's INIT
to nil, then that is used in the default of all other options. But
-setting it to t, i.e. re-enforcing the default for that option,
+setting it to t, i.e., re-enforcing the default for that option,
does not carry to other options."
:link '(info-link "(magit)Log Margin")
:group 'magit-log)
diff --git a/lisp/magit-mode.el b/lisp/magit-mode.el
index ac5a21743a..88a1bb9c65 100644
--- a/lisp/magit-mode.el
+++ b/lisp/magit-mode.el
@@ -231,7 +231,7 @@ and Buffer Variables'."
This affects certain commands such as `magit-show-commit' that
are suffixes of the diff or log transient prefix commands, but
-only if they are invoked directly, i.e. *not* as a suffix.
+only if they are invoked directly, i.e., *not* as a suffix.
Valid values are:
diff --git a/lisp/magit-process.el b/lisp/magit-process.el
index d13efb1bf9..67b39a6b90 100644
--- a/lisp/magit-process.el
+++ b/lisp/magit-process.el
@@ -222,7 +222,7 @@ hook allows users to deal with such questions explicitly.
Each function is called with the process and the output string
as arguments until one of the functions returns non-nil. The
function is responsible for asking the user the appropriate
-question using e.g. `read-char-choice' and then forwarding the
+question using, e.g., `read-char-choice' and then forwarding the
answer to the process using `process-send-string'.
While functions such as `magit-process-yes-or-no-prompt' may not
@@ -955,7 +955,7 @@ as argument."
(magit-git-executable)
"credential-cache--daemon"
magit-credential-cache-daemon-socket)
- ;; Some Git implementations (e.g. Windows) won't have
+ ;; Some Git implementations (e.g., Windows) won't have
;; this program; if we fail the first time, stop trying.
((debug error)
(remove-hook 'magit-credential-hook
diff --git a/lisp/magit-repos.el b/lisp/magit-repos.el
index 59f036763b..0bd3cd7a7c 100644
--- a/lisp/magit-repos.el
+++ b/lisp/magit-repos.el
@@ -342,8 +342,8 @@ If it contains \"%s\" then the directory is substituted for
that."
See `tabulated-list--get-sorter'. Given a more reasonable API
this would not be necessary and one could just use SORT-PREDICATE
directly. CONVERT-CELL can be used to turn the cell value, which
-is always a string back into e.g. a number. COLUMN-IDX has to be
-the index of the column that uses the returned sorter function."
+is always a string back into, e.g., a number. COLUMN-IDX has to
+be the index of the column that uses the returned sorter function."
(lambda (a b)
(funcall sort-predicate
(funcall convert-cell (aref (cadr a) column-idx))
diff --git a/lisp/magit-section.el b/lisp/magit-section.el
index d9de24478c..8626058c70 100644
--- a/lisp/magit-section.el
+++ b/lisp/magit-section.el
@@ -79,7 +79,7 @@ diff-related sections being the only exception.")
"Hook used to set the initial visibility of a section.
Stop at the first function that returns non-nil. The returned
value should be `show', `hide' or nil. If no function returns
-non-nil, determine the visibility as usual, i.e. use the
+non-nil, determine the visibility as usual, i.e., use the
hardcoded section specific default (see `magit-insert-section').")
;;; Options
@@ -1275,7 +1275,7 @@ appropriate package prefix. This works due to some
undocumented
kludges, which are not available to other packages.
When optional HIDE is non-nil collapse the section body by
-default, i.e. when first creating the section, but not when
+default, i.e., when first creating the section, but not when
refreshing the buffer. Else expand it by default. This can be
overwritten using `magit-section-set-visibility-hook'. When a
section is recreated during a refresh, then the visibility of
diff --git a/lisp/magit-sequence.el b/lisp/magit-sequence.el
index d02e68127e..7208e924b6 100644
--- a/lisp/magit-sequence.el
+++ b/lisp/magit-sequence.el
@@ -976,7 +976,7 @@ If no such sequence is in progress, do nothing."
(defun magit-rebase--todo ()
"Return `git-rebase-action' instances for remaining rebase actions.
These are ordered in that the same way they'll be sorted in the
-status buffer (i.e. the reverse of how they will be applied)."
+status buffer (i.e., the reverse of how they will be applied)."
(let ((comment-start (or (magit-get "core.commentChar") "#"))
lines)
(with-temp-buffer
diff --git a/lisp/magit-wip.el b/lisp/magit-wip.el
index d6ca07c9bd..0852a0597d 100644
--- a/lisp/magit-wip.el
+++ b/lisp/magit-wip.el
@@ -110,7 +110,7 @@ is used as `branch-ref'."
(define-minor-mode magit-wip-mode
"Save uncommitted changes to work-in-progress refs.
-Whenever appropriate (i.e. when dataloss would be a possibility
+Whenever appropriate (i.e., when dataloss would be a possibility
otherwise) this mode causes uncommitted changes to be committed
to dedicated work-in-progress refs.
diff --git a/lisp/magit-worktree.el b/lisp/magit-worktree.el
index a4275f7e13..83db2e45b9 100644
--- a/lisp/magit-worktree.el
+++ b/lisp/magit-worktree.el
@@ -33,7 +33,7 @@
(defcustom magit-worktree-read-directory-name-function #'read-directory-name
"Function used to read a directory for worktree commands.
This is called with one argument, the prompt, and can be used
-to e.g. use a base directory other than `default-directory'.
+to, e.g., use a base directory other than `default-directory'.
Used by `magit-worktree-checkout' and `magit-worktree-branch'."
:package-version '(magit . "3.0.0")
:group 'magit-commands
diff --git a/lisp/magit.el b/lisp/magit.el
index f30a5c8f51..cfa6356c4c 100644
--- a/lisp/magit.el
+++ b/lisp/magit.el
@@ -228,7 +228,7 @@ and/or `magit-branch-remote-head'."
(defface magit-signature-error
'((t :foreground "light blue"))
- "Face for signatures that cannot be checked (e.g. missing key)."
+ "Face for signatures that cannot be checked (e.g., missing key)."
:group 'magit-faces)
(defface magit-cherry-unmatched
@@ -626,7 +626,7 @@ and Emacs to it."
(setq magit-version (match-string 1 dirname)))))
;; If all else fails, just report the commit hash. It's
;; better than nothing and we cannot do better in the case
- ;; of e.g. a shallow clone.
+ ;; of e.g., a shallow clone.
(progn
(push 'hash debug)
;; Same check as above to see if it's really the Magit repo.
