Don't assume archive read from stdin starts at offset 0
[tar.git] / README-hacking
blob25bb0c23c9ca3abe81a5567cbb71252a1ca140cb
1 These notes intend to help people working on the Git version of
2 this package.
4 * Requirements
6 You need the following packages to build the Git version of GNU
7 tar.  We do not make any efforts to accommodate older versions of
8 these packages, so please make sure that you have the latest stable
9 version.
11 - Autoconf <http://www.gnu.org/software/autoconf/>
12 - Automake <http://www.gnu.org/software/automake/>
13 - Bison <http://www.gnu.org/software/bison/>
14 - M4 <http://www.gnu.org/software/m4/>
15 - Gettext <http://www.gnu.org/software/gettext/>
16 - Git <http://git.or.cz>
17 - Gzip <http://www.gnu.org/software/gzip/>
18 - Texinfo <http://www.gnu.org/software/texinfo>
19 - Wget <http://www.gnu.org/software/wget/>
21 Up-to-date compilers and libraries are also recommended, for better
22 static checking.  You may be able to use an older compiler by building
23 with 'make WERROR_CFLAGS='; if so, don't worry about its false alarms.
25 Valgrind <http://valgrind.org/> is also highly recommended, if
26 Valgrind supports your architecture.
28 * Bootstrapping
30 Obviously, if you are reading these notes, you did manage to clone
31 tar from Git. The next step is to get other files needed to build,
32 which are extracted from other source packages:
34 1. Change to the source tree directory
36    cd tar
38 2. Run
40    ./bootstrap
42 Once done, proceed as described in the file README (section
43 INSTALLATION).
45 Normally you will have to run bootstrap only once. However, if you
46 intend to hack on GNU tar, you might need to run it again later.
47 There are lots of options that you may find useful in this case.
48 See './bootstrap --help' for a detailed list.
50 Bootstrapping obtains Gnulib and Paxutils files from their Git
51 repositories on Savannah.  Then, it fetches translations from the
52 Translation Project, and, finally, it builds files useful for
53 configuration.  Simply running ./bootstrap without arguments should do
54 in most cases.
56 The file bootstrap.conf contains bootstrapping configuration.
57 Several options are provided that modify its behavior.
58 Run './bootstrap --help' for a list.
60 To only fetch auxiliary files from the network, run './bootstrap --pull'.
61 To only generate files such as 'configure', without accessing the
62 network, run './bootstrap --gen'.
65 * Copyright information
67 Copyright 2007-2024 Free Software Foundation, Inc.
69 This file is part of GNU tar.
71 GNU tar is free software; you can redistribute it and/or modify
72 it under the terms of the GNU General Public License as published by
73 the Free Software Foundation; either version 3 of the License, or
74 (at your option) any later version.
76 GNU tar is distributed in the hope that it will be useful,
77 but WITHOUT ANY WARRANTY; without even the implied warranty of
78 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
79 GNU General Public License for more details.
81 You should have received a copy of the GNU General Public License
82 along with this program.  If not, see <http://www.gnu.org/licenses/>.
85 Local Variables:
86 mode: outline
87 paragraph-separate: "[  ^L]*$"
88 version-control: never
89 End: