[2/6] logging-log4cxx git commit: Docs

[ts...@apache.org]

Docs


Project: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/commit/e1265f0f
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/tree/e1265f0f
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/diff/e1265f0f

Branch: refs/heads/next_stable
Commit: e1265f0fd3e44d6cac1c5ea3a417a313a5284cf5
Parents: f5f73b6
Author: Thorsten Schöning <ts...@am-soft.de>
Authored: Wed Aug 16 19:58:54 2017 +0200
Committer: Thorsten Schöning <ts...@am-soft.de>
Committed: Wed Aug 16 19:58:54 2017 +0200

----------------------------------------------------------------------
 releasePerform.sh | 33 +++++++++++++++++----------------
 1 file changed, 17 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4cxx/blob/e1265f0f/releasePerform.sh
----------------------------------------------------------------------
diff --git a/releasePerform.sh b/releasePerform.sh
index e1d7a01..99f542f 100755
--- a/releasePerform.sh
+++ b/releasePerform.sh
@@ -18,20 +18,22 @@
 ##
 # Perform a release.
 #
-# Performing a release involves Maven currently to build an test things and we
-# ran into problems with the default dir structure maven assumes. This script
-# works around those and we need to sign the release archives anyway, which can
-# be easily automated as well to not need to follow manual instructions always.
+# Performing a release involves Maven currently to build and test things and we ran into problems
+# with the default dir structure maven assumes. This script works around those and we need to sign
+# the release archives anyway, which can be easily automated as well to not need to follow manual 
+# instructions always.
+#
+# It's impoirtant to note that this script is expected to be executed in the branch "next_stable",
+# most likely prepared by the preparing counterpart.
 #
 
-# log4cxx is able to build using private copies of apr and apr-util, which are
-# expected in some special relative dir structure. That doesn't work with the
-# default working dir "perform" uses, which is "target/checkout". So we either
-# need to make apr and apr-util available in "target" or change the working
-# dir. Making available seems easy using symlinks, but "mvn clean" deletes the
-# contents(!) of the linked dirs then. And always copying things around seems a
-# bit unnecessary as well, so I'm using a relocation of the folder for now. The
-# downside is that "mvn clean" is ignoring that dir by default...
+# log4cxx is able to build using private copies of apr and apr-util, which are expected in some 
+# special relative dir structure. That doesn't work with the default working dir "perform" uses, 
+# which is "target/checkout". So we either need to make apr and apr-util available in "target" or 
+# change the working dir. Making available seems easy using symlinks, but "mvn clean" deletes the
+# contents(!) of the linked dirs then. And always copying things around seems a bit unnecessary as
+# well, so I'm using a relocation of the folder for now. The downside is that "mvn clean" ignores
+# that dir by default...
 WD_RELEASE="$(pwd)/../log4cxx-next_stable"
 WD_DIST_DEV="$(pwd)/../log4cxx-dist-dev"
 
@@ -47,8 +49,7 @@ then
 fi
 svn up
 
-# Might be a good idea to have another look at the GPG plugin for Maven in the
-# future:
+# Might be a good idea to have another look at the GPG plugin for Maven in the future:
 #
 # http://blog.sonatype.com/2010/01/how-to-generate-pgp-signatures-with-maven/
 # http://maven.apache.org/plugins/maven-gpg-plugin/
@@ -61,8 +62,8 @@ do
   md5sum        "${file}" > "${file}.md5"
   sha512sum     "${file}" > "${file}.sha"
 
-  # No symlinks because those would be treated as is, no hardlinks because it
-  # should be safer for commits.
+  # No symlinks because those would be treated as is, no hardlinks because it should be safer for
+  # commits.
   cp  --force   "${file}"     "${WD_DIST_DEV}"
   cp  --force   "${file}.asc" "${WD_DIST_DEV}"
   cp  --force   "${file}.md5" "${WD_DIST_DEV}"