Skip to content

Commit

Permalink
* README: Mention README-GIT and download.sh.
Browse files Browse the repository at this point in the history
* README-GIT: Renamed from README-CVS.  Adapted for Git use.

* Makefile.in (MANIFEST): Add further files to be excluded.

* download.sh: New file.
  • Loading branch information
albinus committed Dec 14, 2012
1 parent 8ffbfa2 commit 65ca741
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 7 deletions.
10 changes: 10 additions & 0 deletions ChangeLog
@@ -1,3 +1,13 @@
2012-12-14 Michael Albinus <michael.albinus@gmx.de>

* README: Mention README-GIT and download.sh.

* README-GIT: Renamed from README-CVS. Adapted for Git use.

* Makefile.in (MANIFEST): Add further files to be excluded.

* download.sh: New file.

2012-12-06 Michael Albinus <michael.albinus@gmx.de>

* Makefile.in (XEMACS_FILES): Remove lisp/tramp-util.el and
Expand Down
15 changes: 9 additions & 6 deletions Makefile.in
Expand Up @@ -137,12 +137,15 @@ cvstag:
# Depends on configure in order to run autoconf. All files
# which shall be produced on customer host should be removed.
MANIFEST: configure distclean
find . \( -name CVS -prune \) \
-o \( -name info -prune \) \
-o \( -name tmp -prune \) \
-o \( -name tramp2 -prune \) \
-o \( -type f \! -name *,v \
\! -name .cvsignore \) \
find . \( -name CVS -prune \) \
-o \( -name .git -prune \) \
-o \( -name info -prune \) \
-o \( -name obsolete -prune \) \
-o \( -name tmp -prune \) \
-o \( -name tramp2 -prune \) \
-o \( -type f \! -name *,v \
\! -name .cvsignore \
\! -name .gitignore \) \
-print > MANIFEST
./config.status

Expand Down
3 changes: 2 additions & 1 deletion README
Expand Up @@ -20,11 +20,12 @@ Makefile.in What I use for building Tramp.
Makefile.XEmacs What the XEmacs package maintainer uses to build
Tramp.
README This file.
README-CVS For the brave ones who want to get the latest
README-GIT For the brave ones who want to get the latest
developer sources.
aclocal.m4 Macros used by autoconf for generating the
configure script.
configure.ac Input for autoconf for generating the configure script.
download.sh A script to download Tramp sources via wget instead git.
package-info.in Used for the XEmacs package.

All other files in this directory are generated by either autoconf,
Expand Down
37 changes: 37 additions & 0 deletions README-GIT
@@ -0,0 +1,37 @@
-*- text -*-

Tramp Git usage instructions

The Tramp version number is in the `AC_INIT' macro in `configure.ac',
everywhere else it is generated from this macro. You should update
this version number whenever you make a release. After that, you need
to call `make configure' (or `autoconf --trace=AC_INIT' if you've
cleaned up the Makefile). The version number looks like "X.Y.Z" where
X is the major revision, Y is the minor revision, and Z is a patch
level.

Tramp versions which are not released yet have a version number
"X.Y.Z-pre" in Git, with Z being the next patch level to be released.

Together with each version "X.Y.Z" there should be a Git tag "V-X-Y-Z"
so that each released version can be identified.

Maybe someday the version number should be auto-generated from the
Git tag name so that you don't have to maintain the version number
three times.

A Tramp version X.Y, which is regarded as stable, is maintained in a
Git branch "branch-X-Y-stable". Those Tramp versions don't get new
features but just bug fixes. Ususally, the Git HEAD is not based on
such a version but a higher one.

Tramp exists in three incarnations. The Git tree on Savannah is the
main version, but there is also a copy in XEmacs packages repository
and a copy in the Emacs distribution. Typically, these downstream
versions are based on, or identical to, an earlier stable version from
Savannah.

When Git is not installed locally, the master branch of Tramp can be
downloaded via the script "download.sh".

TODO: explain how to get the main version into XEmacs and into Emacs.
34 changes: 34 additions & 0 deletions download.sh
@@ -0,0 +1,34 @@
#!/bin/sh

# This script downloads the major files from the Tramp Git repository.
# It requires a running "wget program.

TRAMP_GIT_DIR=http://git.savannah.gnu.org/cgit/tramp.git/plain
TRAMP_TARGET_DIR=tramp
TRAMP_SUB_DIRS="contrib lisp test texi"

# Check, that the target directory and the index files do not exist.
for file in plain $TRAMP_SUB_DIRS $TRAMP_TARGET_DIR; do
if [ -e $file ]; then
echo \"$file\" exist, exiting
exit
fi
done

# Download index files.
wget --convert-links -nH -nd $TRAMP_GIT_DIR
for subdir in $TRAMP_SUB_DIRS; do
wget --convert-links -nH -nd $TRAMP_GIT_DIR/$subdir
done

# Download upper directory. The subdirectories produce a respective
# index.html file; this must be removed.
mkdir $TRAMP_TARGET_DIR
cd $TRAMP_TARGET_DIR
wget -F -i ../plain
rm -f index.html* ../plain

# Download subdirectories.
for subdir in $TRAMP_SUB_DIRS; do
(mkdir $subdir; cd $subdir; wget -F -i ../../$subdir; rm -f ../../$subdir)
done

0 comments on commit 65ca741

Please sign in to comment.