diff mbox series

[v2,1/3] Documentation: alias: rework notes into points

Message ID 20240523042143.1220862-1-iwienand@redhat.com (mailing list archive)
State Superseded
Headers show
Series [v2,1/3] Documentation: alias: rework notes into points | expand

Commit Message

Ian Wienand May 23, 2024, 4:20 a.m. UTC 
There are a number of caveats when using aliases.  Rather than
stuffing them all together in a paragraph, let's separate them out
into individual points to make it clearer what's going on.
---
 Documentation/config/alias.txt | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Eric Sunshine May 23, 2024, 4:27 a.m. UTC | #1 
On Thu, May 23, 2024 at 12:22 AM Ian Wienand <iwienand@redhat.com> wrote:
> There are a number of caveats when using aliases.  Rather than
> stuffing them all together in a paragraph, let's separate them out
> into individual points to make it clearer what's going on.
> ---

Missing sign-off.
Ian Wienand May 23, 2024, 4:39 a.m. UTC | #2 
On Thu, May 23, 2024 at 12:27:17AM -0400, Eric Sunshine wrote:
> On Thu, May 23, 2024 at 12:22 AM Ian Wienand <iwienand@redhat.com> wrote:
> > There are a number of caveats when using aliases.  Rather than
> > stuffing them all together in a paragraph, let's separate them out
> > into individual points to make it clearer what's going on.
> > ---
> 
> Missing sign-off.

Sigh .. thanks sent v3

-i
diff mbox series

Patch

diff --git a/Documentation/config/alias.txt b/Documentation/config/alias.txt
index 01df96fab3..40851ef429 100644
--- a/Documentation/config/alias.txt
+++ b/Documentation/config/alias.txt
@@ -21,8 +21,9 @@  If the alias expansion is prefixed with an exclamation point,
 it will be treated as a shell command.  For example, defining
 `alias.new = !gitk --all --not ORIG_HEAD`, the invocation
 `git new` is equivalent to running the shell command
-`gitk --all --not ORIG_HEAD`.  Note that shell commands will be
-executed from the top-level directory of a repository, which may
-not necessarily be the current directory.
-`GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
-from the original current directory. See linkgit:git-rev-parse[1].
+`gitk --all --not ORIG_HEAD`.  Note:
++
+* Shell commands will be executed from the top-level directory of a
+  repository, which may not necessarily be the current directory.
+* `GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
+  from the original current directory. See linkgit:git-rev-parse[1].