aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXinglu Chen <public@yoctocell.xyz>2021-06-21 15:23:21 +0200
committerXinglu Chen <public@yoctocell.xyz>2021-06-21 15:23:21 +0200
commitaebea916b6e0b35e68a9ba3cafdd760d390336b0 (patch)
tree7632944aa7b23bdf1d88d58e1f334a1fab29cc60
parent1b2f4219e9375642491d490ce0c421f8ec966524 (diff)
doc: Formatting changes.
Use more appropriate commands instead of @samp{}. * git-email.texi: Formatting changes. Signed-off-by: Xinglu Chen <public@yoctocell.xyz>
-rw-r--r--doc/git-email.texi82
1 files changed, 41 insertions, 41 deletions
diff --git a/doc/git-email.texi b/doc/git-email.texi
index 632e29e..0653dae 100644
--- a/doc/git-email.texi
+++ b/doc/git-email.texi
@@ -99,15 +99,15 @@ Emacs, it offers two main functions for sending email with Git.
@itemize
@item
-@samp{git-email-send-email} will send the marked files as patches using your
+@code{git-email-send-email} will send the marked files as patches using your
mail client of choice. This means that you have to first run
-@samp{git format-patch} to generate the patches.
+@code{git format-patch} to generate the patches.
@item
-@samp{git-email-format-patch} will ask you for a base revision and generate
+@code{git-email-format-patch} will ask you for a base revision and generate
patches for all the changes that occured between the revision and
the current HEAD@. It will then prepare the patches as email
-messages in the same way as @samp{git-email-send-email}.
+messages in the same way as @code{git-email-send-email}.
@end itemize
If you want to easily apply patches you have recieved via email, you
@@ -166,7 +166,7 @@ You can install git-email with guix by running @command{guix install
@findex git-email-send-email
When you are in a dired, vc-dir, or ibuffer buffer, you can mark patch
-files and run @samp{git-email-send-email} to send the patches. If you arent
+files and run @code{git-email-send-email} to send the patches. If you arent
in one of those bufffers, you will be prompted to enter a file path in
the minibuffer.
@@ -174,35 +174,35 @@ Once a message has been created, your cursor will automatically be
placed in the appropriate location. This means that if the subject or
"to" address is empty, the cursor will automatically be there already.
-By default, the built-in @samp{message-mail} function will be used for
+By default, the built-in @code{message-mail} function will be used for
composing the message. You can change this to something else by
-customizing the @samp{git-email-compose-email-function}.
+customizing the @code{git-email-compose-email-function}.
@node git-email-format-patch
@subsection git-email-format-patch
@findex git-email-format-patch
-When you invoke @samp{git-email-format-patch}, you will prompted in the
-minibuffer for extra arguments to give @samp{git format-patch}. Some common
+When you invoke @code{git-email-format-patch}, you will prompted in the
+minibuffer for extra arguments to give @code{git format-patch}. Some common
arguments will be displayed in your completion framework. If you want
-to select multiple options, separate them with @samp{,} or whatever the value
-of @samp{crm-separator} is. You can add options to the list of candidates by
-customizing @samp{git-email-format-patch-extra-args}.
-@samp{git-email-format-patch-default-args} contains arguments automatically
-passed to @samp{git format-patch} if no extra arguments are given.
+to select multiple options, separate them with @code{,} or whatever the value
+of @code{crm-separator} is. You can add options to the list of candidates by
+customizing @code{git-email-format-patch-extra-args}.
+@code{git-email-format-patch-default-args} contains arguments automatically
+passed to @code{git format-patch} if no extra arguments are given.
After you have entered extra arguments, the minibuffer will prompt you
to select the @emph{base} commit for your patches. That is, a patch will be
generated for the changes between the @emph{base} commit and the current
HEAD@. Selecting the second candidate in the list is equivalent to
-typing @samp{HEAD^1} in the shell. If you are already in a VC log buffer,
+typing @code{HEAD^1} in the shell. If you are already in a VC log buffer,
the revision under point will be used automatically.
When the revision has been selected, patches will be generated and you
will be greeted with a message buffer containing a patch, just like
-with @samp{git-email-send-email}. By default, the generated patches will be
+with @code{git-email-send-email}. By default, the generated patches will be
deleted, if you don not like this behaviour, call
-@samp{git-email-format-patch} with a prefix argument (C-u).
+@code{git-email-format-patch} with a prefix argument (C-u).
@findex git-email-rewrite-header
In case you forgot to Cc someone while writing the command line options
@@ -226,8 +226,8 @@ manually switch to every buffer and add the ``To'' address, you can
simply call @code{git-email-rewrite-header}, specify the ``To'' header,
and then the appropriate Debbugs address.
-You can see all the customizable variables running @samp{M-x customize-group}
-@samp{<RET> =git-email <RET>}.
+You can see all the customizable variables running @kbd{M-x
+customize-group @key{RET} git-email @key{RET}}.
@node Customization options
@chapter Customization options
@@ -238,44 +238,44 @@ You can see all the customizable variables running @samp{M-x customize-group}
@itemize
@vindex git-email-compose-email-function
@item
-@samp{git-email-compose-email-function} is the function used to compose an
-email, defaults to @samp{mesage-mail}.
+@code{git-email-compose-email-function} is the function used to compose an
+email, defaults to @code{mesage-mail}.
@vindex git-email-send-email-function
@item
-@samp{git-email-send-email-function} is the function used to send the
-email, defaults to @samp{message-send-and-exit}.
+@code{git-email-send-email-function} is the function used to send the
+email, defaults to @code{message-send-and-exit}.
@vindex git-email-pre-compose-email-hook
@item
-@samp{git-email-pre-compose-email-hook} is a list of functions to be
+@code{git-email-pre-compose-email-hook} is a list of functions to be
executed before composing messages. This useful if you want to do
extra formatting of the message.
@vindex git-email-post-compose-email-hook
@item
-@samp{git-email-post-compose-email-hook} is a list of functions to be
+@code{git-email-post-compose-email-hook} is a list of functions to be
executed after sending the messages. You could for example run
‘notmuch new’ to index your messages.
@vindex git-email-headers
@item
-@samp{git-email-headers} is a list of headers to include in the message,
+@code{git-email-headers} is a list of headers to include in the message,
you probably should not touch this unless you really know what you
are doing.
@vindex git-email-get-files-functions
@item
-@samp{git-email-get-files-functions} is a list of functions to run to get
+@code{git-email-get-files-functions} is a list of functions to run to get
a list of patches to send. The default, there is already support
for dired, ibuffer and vc-dir.
@vindex git-email-get-to-address-function
@item
-@samp{git-email-get-to-address-function} is a function that returns the
-“to” address for a message. The default function runs @samp{git config
- --list} to get the address, this will not work unless you are in a
-git repository.
+@code{git-email-get-to-address-function} is a function that returns the
+``to'' address for a message. The default function runs @command{git
+config --list} to get the address, this will not work unless you are in
+a git repository.
@end itemize
@node Format patches
@@ -284,13 +284,13 @@ git repository.
@itemize
@vindex git-email-format-patch-default-args
@item
-@samp{git-email-format-patch-default-args} is a string of arguments to give
-@samp{git format-patch} by default. If you choose to give extra arguments,
+@code{git-email-format-patch-default-args} is a string of arguments to give
+@code{git format-patch} by default. If you choose to give extra arguments,
the default arguments will not be used.
@vindex git-email-format-patch-extra-args
@item
-@samp{git-email-format-patch-extra-args} is a list of arguments presented
+@code{git-email-format-patch-extra-args} is a list of arguments presented
in your completion framework when entering extra arguments to give
to ‘git format-patch’. These arguments are just there for the sake
of convience, you are not restricted to just the arguments in this
@@ -298,18 +298,18 @@ list.
@vindex git-email-revision-limit
@item
-@samp{git-email-revision-limit} controls the number of revisions to show in
+@code{git-email-revision-limit} controls the number of revisions to show in
the minibuffer when choosing a base revision.
@vindex git-email-revision-command
@item
-@samp{git-email-revision-command} is the command to run to get a list of
+@code{git-email-revision-command} is the command to run to get a list of
revisions. If you change this, you will most likely also have to
-change @samp{git-email-revision-parser} variable
+change @code{git-email-revision-parser} variable
@vindex git-email-get-revision-functions
@item
-@samp{git-email-get-revision-functions} is a list of functions to run to
+@code{git-email-get-revision-functions} is a list of functions to run to
try to get the base revision for the patches. If all of the
functions return nil, it fallsback to
‘git-email--minibuffer-get-revision’. By default, it will get the
@@ -322,7 +322,7 @@ revision of under point if you are in a VC log buffer.
@itemize
@vindex git-email-get-current-project-functions
@item
-@samp{git-email-get-current-project-functions} is a hook that is executed
+@code{git-email-get-current-project-functions} is a hook that is executed
to get the path of the current project. The path must include a
trailing @samp{/}.
@@ -343,9 +343,9 @@ unsent patch to *** TO ADDRESS HERE *** *}.
minor modes will just configure some variables for you and provide any
extra functionality as of right now.
-There is also integration with magit in the @samp{git-email-magit.el}
+There is also integration with magit in the @file{git-email-magit.el}
library. This will faciliate the transient library, you can send a
-patch from the magit status buffer by pressing @samp{W c s}.
+patch from the magit status buffer by pressing @kbd{W c s}.
@node Acknowledgements
@chapter Acknowledgements