Update version number and update documentation

* Improve handling of submodules at upgrade (yadm-dev#284, yadm-dev#285, yadm-dev#293) * Improve Zsh completions (yadm-dev#292, yadm-dev#298) * Use stderr for error messages (yadm-dev#297)
stephendevey · Jan 7, 2021 · afab29c · afab29c
1 parent 9b83169
commit afab29c
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 15 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,8 @@
+3.0.1
+  * Improve handling of submodules at upgrade (#284, #285, #293)
+  * Improve Zsh completions (#292, #298)
+  * Use stderr for error messages (#297)
+
 3.0.0
   * Support encryption with OpenSSL (#138)
   * Support "include" directive in built-in template processor (#255)

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -1,8 +1,8 @@
 CONTRIBUTORS
 
 Tim Byrne
-Martin Zuther
 Erik Flodin
+Martin Zuther
 Jan Schulz
 Jonathan Daigle
 Luis López

diff --git a/README.md b/README.md
@@ -72,7 +72,7 @@ The star count helps others discover yadm.
 [master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master
 [master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
 [master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
-[obs-badge]: https://img.shields.io/badge/OBS-v3.0.0-blue
+[obs-badge]: https://img.shields.io/badge/OBS-v3.0.1-blue
 [obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
 [releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
 [releases-link]: https://github.com/TheLocehiliosan/yadm/releases

diff --git a/contrib/hooks/encrypt_with_checksums/post_encrypt b/contrib/hooks/encrypt_with_checksums/post_encrypt
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # yadm - Yet Another Dotfiles Manager
-# Copyright (C) 2015-2020 Tim Byrne and Martin Zuther
+# Copyright (C) 2015-2021 Tim Byrne and Martin Zuther
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

diff --git a/contrib/hooks/encrypt_with_checksums/post_list b/contrib/hooks/encrypt_with_checksums/post_list
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # yadm - Yet Another Dotfiles Manager
-# Copyright (C) 2015-2020 Tim Byrne and Martin Zuther
+# Copyright (C) 2015-2021 Tim Byrne and Martin Zuther
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

diff --git a/contrib/hooks/encrypt_with_checksums/post_status b/contrib/hooks/encrypt_with_checksums/post_status
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # yadm - Yet Another Dotfiles Manager
-# Copyright (C) 2015-2020 Tim Byrne and Martin Zuther
+# Copyright (C) 2015-2021 Tim Byrne and Martin Zuther
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

diff --git a/yadm b/yadm
@@ -1,6 +1,6 @@
 #!/bin/sh
 # yadm - Yet Another Dotfiles Manager
-# Copyright (C) 2015-2020 Tim Byrne
+# Copyright (C) 2015-2021 Tim Byrne
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -20,7 +20,7 @@ if [ -z "$BASH_VERSION" ]; then
   [ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
 fi
 
-VERSION=3.0.0
+VERSION=3.0.1
 
 YADM_WORK="$HOME"
 YADM_DIR=

diff --git a/yadm.1 b/yadm.1
@@ -1,5 +1,5 @@
 .\" vim: set spell so=8:
-.TH yadm 1 "30 December 2020" "3.0.0"
+.TH yadm 1 "7 January 2021" "3.0.1"
 
 .SH NAME
 

diff --git a/yadm.md b/yadm.md
@@ -36,7 +36,7 @@
 
        yadm transcrypt [ options ]
 
-       yadm upgrade
+       yadm upgrade [-f]
 
        yadm introspect category
 
@@ -203,11 +203,19 @@
               command  will  start  by  moving your yadm repo to the new path.
               Next it will move any archive data.  If the archive  is  tracked
               within your yadm repo, this command will "stage" the renaming of
-              that file in the repo's index.  Upgrading will also  re-initial-
-              ize all submodules you have added (otherwise they will be broken
-              when the repo moves).  After running "yadm upgrade", you  should
-              run  "yadm status" to review changes which have been staged, and
-              commit them to your repository.
+              that file in the repo's index.
+
+              Upgrading will attempt to de-initialize and  re-initialize  your
+              submodules.  If  your  submodules  cannot be de-initialized, the
+              upgrade will fail. The most common reason submodules  will  fail
+              to  de-initialize  is  because they have local modifications. If
+              you are willing to lose the local modifications to those submod-
+              ules,  you  can  use the -f option with the "upgrade" command to
+              force the de-initialization.
+
+              After running "yadm upgrade", you should run  "yadm  status"  to
+              review  changes  which have been staged, and commit them to your
+              repository.
 
               You can read https://yadm.io/docs/upgrade_from_2 for more infor-
               mation.

diff --git a/yadm.spec b/yadm.spec
@@ -1,7 +1,7 @@
 %{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
 Name: yadm
 Summary: Yet Another Dotfiles Manager
-Version: 3.0.0
+Version: 3.0.1
 Group: Development/Tools
 Release: 1%{?dist}
 URL: https://yadm.io