emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/magit bfbab898a8 4/8: manual: Copyedit FAQ a bit


From: Jonas Bernoulli
Subject: [nongnu] elpa/magit bfbab898a8 4/8: manual: Copyedit FAQ a bit
Date: Mon, 23 Dec 2024 16:44:25 -0500 (EST)

branch: elpa/magit
commit bfbab898a80e7bce839f65f1985076e1056aeddf
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    manual: Copyedit FAQ a bit
---
 docs/magit.org  | 29 +++++++++++++++--------------
 docs/magit.texi | 29 +++++++++++++++--------------
 2 files changed, 30 insertions(+), 28 deletions(-)

diff --git a/docs/magit.org b/docs/magit.org
index b0a1a25c5b..ca46915445 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -9012,7 +9012,7 @@ to pronounce Magit like magic, while taking into account 
that C and T
 do not sound the same.
 
 The German "Magie" is not pronounced the same as the English "magic",
-so if you speak German then you can use the above rationale to justify
+so if you speak German, then you can use the above rationale to justify
 using the former pronunciation; ~Mag{ie => it}~.
 
 You can also choose to use the former pronunciation just because you
@@ -9024,30 +9024,31 @@ Also see 
https://emacs.stackexchange.com/questions/13696.
 *** How to show git's output?
 
 To show the output of recently run git commands, press ~$~ (or, if that
-isn't available, ~M-x magit-process-buffer~).  This will show a buffer
+isn't available, use ~M-x magit-process-buffer~).  This shows a buffer
 containing a section per git invocation; as always press ~TAB~ to expand
 or collapse them.
 
-By default, git's output is only inserted into the process buffer if it
-is run for side-effects.  When the output is consumed in some way,
-also inserting it into the process buffer would be too expensive.  For
-debugging purposes, it's possible to do so anyway by setting
-~magit-git-debug~ to ~t~.
+By default, git's output is only inserted into the process buffer if
+it is run for side-effects.  When the output is consumed in some way,
+also inserting it into the process buffer would be too expensive.
+For debugging purposes, it's possible to do so anyway, using ~M-x
+magit-toggle-git-debug~.
 
 *** How to install the gitman info manual?
 
 Git's manpages can be exported as an info manual called ~gitman~.
 Magit's own info manual links to nodes in that manual instead of the
-actual manpages because Info doesn't support linking to manpages.
+actual manpages, simply because Info doesn't support linking to
+manpages.
 
 Unfortunately some distributions do not install the ~gitman~ manual by
-default and you will have to install a separate documentation package
+default and you would have to install a separate documentation package
 to get it.
 
-Magit patches Info adding the ability to visit links to the ~gitman~
-Info manual by instead viewing the respective manpage.  If you prefer
+Magit patches info, adding the ability to visit links to the ~gitman~
+info manual, by instead viewing the respective manpage.  If you prefer
 that approach, then set the value of ~magit-view-git-manual-method~ to
-one of the supported packages ~man~ or ~woman~, e.g.:
+one of the supported Emacs packages ~man~ or ~woman~, e.g.:
 
 #+begin_src emacs-lisp
   (setq magit-view-git-manual-method 'man)
@@ -9100,7 +9101,7 @@ commit.  Also see [[*Performance]].
 *** I am having problems committing
 
 That likely means that Magit is having problems finding an appropriate
-emacsclient executable.  See [[info:with-editor#Configuring With-Editor]]
+~emacsclient~ executable.  See [[info:with-editor#Configuring With-Editor]]
 and [[info:with-editor#Debugging]].
 
 *** I am using MS Windows and cannot push with Magit
@@ -9134,7 +9135,7 @@ undo that setting in Magit by customizing 
~magit-git-global-arguments~.
 Neither Magit nor ~git-commit.el~ fiddle with point in the buffer used
 to write commit messages, so something else must be doing it.
 
-You have probably globally enabled a mode which restores point in
+You have probably globally enabled a mode, which restores point in
 file-visiting buffers.  It might be a bit surprising, but when you
 write a commit message, then you are actually editing a file.
 
diff --git a/docs/magit.texi b/docs/magit.texi
index 7c520ac175..01f1bb5d61 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -11061,7 +11061,7 @@ to pronounce Magit like magic, while taking into 
account that C and T
 do not sound the same.
 
 The German "Magie" is not pronounced the same as the English "magic",
-so if you speak German then you can use the above rationale to justify
+so if you speak German, then you can use the above rationale to justify
 using the former pronunciation; @code{Mag@{ie => it@}}.
 
 You can also choose to use the former pronunciation just because you
@@ -11074,31 +11074,32 @@ Also see 
@uref{https://emacs.stackexchange.com/questions/13696}.
 @appendixsubsec How to show git's output?
 
 To show the output of recently run git commands, press @code{$} (or, if that
-isn't available, @code{M-x magit-process-buffer}).  This will show a buffer
+isn't available, use @code{M-x magit-process-buffer}).  This shows a buffer
 containing a section per git invocation; as always press @code{TAB} to expand
 or collapse them.
 
-By default, git's output is only inserted into the process buffer if it
-is run for side-effects.  When the output is consumed in some way,
-also inserting it into the process buffer would be too expensive.  For
-debugging purposes, it's possible to do so anyway by setting
-@code{magit-git-debug} to @code{t}.
+By default, git's output is only inserted into the process buffer if
+it is run for side-effects.  When the output is consumed in some way,
+also inserting it into the process buffer would be too expensive.
+For debugging purposes, it's possible to do so anyway, using @code{M-x
+magit-toggle-git-debug}.
 
 @node How to install the gitman info manual?
 @appendixsubsec How to install the gitman info manual?
 
 Git's manpages can be exported as an info manual called @code{gitman}.
 Magit's own info manual links to nodes in that manual instead of the
-actual manpages because Info doesn't support linking to manpages.
+actual manpages, simply because Info doesn't support linking to
+manpages.
 
 Unfortunately some distributions do not install the @code{gitman} manual by
-default and you will have to install a separate documentation package
+default and you would have to install a separate documentation package
 to get it.
 
-Magit patches Info adding the ability to visit links to the @code{gitman}
-Info manual by instead viewing the respective manpage.  If you prefer
+Magit patches info, adding the ability to visit links to the @code{gitman}
+info manual, by instead viewing the respective manpage.  If you prefer
 that approach, then set the value of @code{magit-view-git-manual-method} to
-one of the supported packages @code{man} or @code{woman}, e.g.:
+one of the supported Emacs packages @code{man} or @code{woman}, e.g.:
 
 @lisp
 (setq magit-view-git-manual-method 'man)
@@ -11174,7 +11175,7 @@ commit.  Also see @ref{Performance}.
 @appendixsubsec I am having problems committing
 
 That likely means that Magit is having problems finding an appropriate
-emacsclient executable.  See @ref{Configuring With-Editor,,,with-editor,}
+@code{emacsclient} executable.  See @ref{Configuring 
With-Editor,,,with-editor,}
 and @ref{Debugging,,,with-editor,}.
 
 @node I am using MS Windows and cannot push with Magit
@@ -11212,7 +11213,7 @@ undo that setting in Magit by customizing 
@code{magit-git-global-arguments}.
 Neither Magit nor @code{git-commit.el} fiddle with point in the buffer used
 to write commit messages, so something else must be doing it.
 
-You have probably globally enabled a mode which restores point in
+You have probably globally enabled a mode, which restores point in
 file-visiting buffers.  It might be a bit surprising, but when you
 write a commit message, then you are actually editing a file.
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]