Rebase history
[platform/upstream/gettext.git] / HACKING
1 All you need to know when hacking (modifying) GNU gettext or when building
2 it off the git repository.
3
4
5 Requirements
6 ============
7
8 You will need reasonably recent versions of the build tools:
9
10   * A C compiler; on Cygwin or mingw also a C++ compiler. Such as GNU GCC.
11     + Homepage:
12       http://gcc.gnu.org/
13
14   * GNU automake
15     + Homepage:
16       http://www.gnu.org/software/automake/
17
18   * GNU autoconf
19     + Homepage:
20       http://www.gnu.org/software/autoconf/
21
22   * GNU m4
23     + Homepage:
24       http://www.gnu.org/software/m4/
25
26   * GNU bison
27     + Homepage:
28       http://www.gnu.org/software/bison/
29
30   * GNU gperf
31     + Homepage:
32       http://www.gnu.org/software/gperf/
33
34   * GNU groff 1.17 or newer
35     + Homepage:
36       http://www.gnu.org/software/groff/
37
38   * GNU texinfo
39     + Homepage:
40       http://www.gnu.org/software/texinfo/
41
42   * GNU emacs or XEmacs
43     + Homepage:
44       http://www.gnu.org/software/emacs/
45       http://www.xemacs.org/
46
47   * Perl
48     + Homepage:
49       http://www.perl.org/
50
51   * TeX (for making the doc in .dvi, .ps or .pdf format)
52     + Homepage:
53       http://tug.org/teTeX/
54
55   * Either an internet connection or a recent copy of GNU gnulib.
56     + Homepage:
57       http://www.gnu.org/software/gnulib/
58
59   * GNU tar (for creating distributable tarballs)
60     + Homepage:
61       http://www.gnu.org/software/tar/
62
63 And, of course, the packages listed in the DEPENDENCIES file.
64
65
66 Building off the git repository
67 ===============================
68
69 Access to the git repository is described at
70   http://savannah.gnu.org/git/?group=gettext
71
72 After fetching the sources from the repository, peek at the comments in
73 autogen.sh, then run "./autogen.sh"; then you can proceed with "./configure"
74 as usual.
75
76 Submitting patches
77 ==================
78
79 Patches should be sent to bug-gettext@gnu.org, the bug/feature mailing
80 list.  You can subscribe to the mailing list, or see the list
81 archives, by following links from
82 http://savannah.gnu.org/mail/?group=gettext .
83
84 To email a patch you can use a shell command like 'git format-patch
85 -1' to create a file, and then attach the file to your email.  
86
87 GNU gettext development no longer stores descriptions of new changes
88 in ChangeLog files.  Instead, a single ChangeLog file is generated
89 from the commit messages when a release is prepared.  So changes you
90 commit should not touch any of the ChangeLog files in the repository,
91 but instead should contain the log entries in the commit message.
92
93 For the style of a ChangeLog entry, see the "Change Logs" section of
94 the GNU coding standards:
95
96   http://www.gnu.org/prep/standards/html_node/Change-Logs.html