magit-branch-maybe-adjust-upstream: Upstream must also exist

2 files changed, 34 insertions, 6 deletions

diff --git a/Documentation/magit.org b/Documentation/magit.org
index 505afc9..e1a7325 100644
--- a/Documentation/magit.org
+++ b/Documentation/magit.org
@@ -8,7 +8,7 @@
 #+TEXINFO_DIR_CATEGORY: Emacs
 #+TEXINFO_DIR_TITLE: Magit: (magit).
 #+TEXINFO_DIR_DESC: Using Git from Emacs with Magit.
-#+SUBTITLE: for version 3.1.1
+#+SUBTITLE: for version 3.1.1 (v3.1.1-2-g5e734c022+1)
 
 #+TEXINFO_DEFFN: t
 #+OPTIONS: H:4 num:3 toc:2
@@ -25,7 +25,7 @@ directly from within Emacs.  While many fine Git clients exist, only
 Magit and Git itself deserve to be called porcelains.
 
 #+TEXINFO: @noindent
-This manual is for Magit version 3.1.1.
+This manual is for Magit version 3.1.1 (v3.1.1-2-g5e734c022+1).
 
 #+BEGIN_QUOTE
 Copyright (C) 2015-2021 Jonas Bernoulli <jonas@bernoul.li>
@@ -4997,7 +4997,7 @@ The variables are described in [[*Branch Git Variables]].
   repositories, then you might use something like:
 
   #+BEGIN_SRC emacs-lisp
-    (("origin/master" "master" "next" "maint"))
+    (("origin/master" . ("master" "next" "maint")))
   #+END_SRC
 
   Or if the names of all your ephemeral branches contain a slash,
@@ -5014,6 +5014,20 @@ The variables are described in [[*Branch Git Variables]].
      ("origin/master" . "\\`feature/"))
   #+END_SRC
 
+  UPSTREAM can be a local branch:
+
+  #+BEGIN_SRC emacs-lisp
+    (("master" . ("master" "next" "maint")))
+  #+END_SRC
+
+Because the main branch is no longer almost always named "master"
+you should also account for other common names:
+
+  #+BEGIN_SRC emacs-lisp
+    (("main"  . ("main" "master" "next" "maint"))
+     ("master" . ("main" "master" "next" "maint")))
+  #+END_SRC
+
 - Command: magit-branch-orphan
 
   This command creates and checks out a new orphan branch with
diff --git a/Documentation/magit.texi b/Documentation/magit.texi
index 3a52213..6381904 100644
--- a/Documentation/magit.texi
+++ b/Documentation/magit.texi
@@ -31,7 +31,7 @@ General Public License for more details.
 @finalout
 @titlepage
 @title Magit User Manual
-@subtitle for version 3.1.1
+@subtitle for version 3.1.1 (v3.1.1-2-g5e734c022+1)
 @author Jonas Bernoulli
 @page
 @vskip 0pt plus 1filll
@@ -53,7 +53,7 @@ directly from within Emacs.  While many fine Git clients exist, only
 Magit and Git itself deserve to be called porcelains.
 
 @noindent
-This manual is for Magit version 3.1.1.
+This manual is for Magit version 3.1.1 (v3.1.1-2-g5e734c022+1).
 
 @quotation
 Copyright (C) 2015-2021 Jonas Bernoulli <jonas@@bernoul.li>
@@ -6732,7 +6732,7 @@ If you use a finite set of non-ephemeral branches across all your
 repositories, then you might use something like:
 
 @lisp
-(("origin/master" "master" "next" "maint"))
+(("origin/master" . ("master" "next" "maint")))
 @end lisp
 
 Or if the names of all your ephemeral branches contain a slash,
@@ -6748,8 +6748,22 @@ Of course you can also fine-tune:
 (("origin/maint" . "\\`hotfix/")
  ("origin/master" . "\\`feature/"))
 @end lisp
+
+UPSTREAM can be a local branch:
+
+@lisp
+(("master" . ("master" "next" "maint")))
+@end lisp
 @end defopt
 
+Because the main branch is no longer almost always named "master"
+you should also account for other common names:
+
+@lisp
+(("main"  . ("main" "master" "next" "maint"))
+ ("master" . ("main" "master" "next" "maint")))
+@end lisp
+
 @cindex magit-branch-orphan
 @deffn Command magit-branch-orphan