maint: update all copyright year number ranges
[platform/upstream/coreutils.git] / README-hacking
index 014114d..7a41141 100644 (file)
@@ -2,7 +2,7 @@
 
 These notes intend to help people working on the checked-out sources.
 These requirements do not apply when building from a distribution tarball.
-See also HACKING for more detailed coreutils contribution guidelines.
+See also HACKING for more detailed contribution guidelines.
 
 * Requirements
 
@@ -19,7 +19,7 @@ Valgrind <http://valgrind.org/> is also highly recommended, if
 Valgrind supports your architecture. See also README-valgrind.
 
 While building from a just-cloned source tree may require installing a
-few prerequisites, later, a plain `git pull && make' should be sufficient.
+few prerequisites, later, a plain 'git pull && make' should be sufficient.
 
 * First GIT checkout
 
@@ -28,11 +28,23 @@ You can get a copy of the source repository like this:
         $ git clone git://git.sv.gnu.org/coreutils
         $ cd coreutils
 
+As an optional step, if you already have a copy of the gnulib git
+repository, then you can use it as a reference to reduce download
+time and disk space requirements:
+
+        $ export GNULIB_SRCDIR=/path/to/gnulib
+
 The next step is to get and check other files needed to build,
 which are extracted from other source packages:
 
         $ ./bootstrap
 
+To use the most-recent gnulib (as opposed to the gnulib version that
+the package last synchronized to), do this next:
+
+        $ git submodule foreach git pull origin master
+        $ git commit -m 'build: update gnulib submodule to latest' gnulib
+
 And there you are!  Just
 
         $ ./configure --quiet #[--enable-gcc-warnings] [*]
@@ -54,9 +66,35 @@ to use recent system headers.  If you configure with this option,
 and spot a problem, please be sure to send the report to the bug
 reporting address of this package, and not to that of gnulib, even
 if the problem seems to originate in a gnulib-provided file.
+
+* Submitting patches
+
+If you develop a fix or a new feature, please send it to the
+appropriate bug-reporting address as reported by the --help option of
+each program.  One way to do this is to use vc-dwim
+<http://www.gnu.org/software/vc-dwim/>), as follows.
+
+  Run the command "vc-dwim --help", copy its definition of the
+  "git-changelog-symlink-init" function into your shell, and then run
+  this function at the top-level directory of the package.
+
+  Edit the (empty) ChangeLog file that this command creates, creating a
+  properly-formatted entry according to the GNU coding standards
+  <http://www.gnu.org/prep/standards/html_node/Change-Logs.html>.
+
+  Make your changes.
+
+  Run the command "vc-dwim" and make sure its output (the diff of all
+  your changes) looks good.
+
+  Run "vc-dwim --commit".
+
+  Run the command "git format-patch --stdout -1", and email its output
+  in, using the output's subject line.
+
 -----
 
-Copyright (C) 2002-2009 Free Software Foundation, Inc.
+Copyright (C) 2002-2013 Free Software Foundation, Inc.
 
 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