Jim Meyering
5e1f5c5739
doc: identify/refer to source of each fixed bug in log and in NEWS
...
* HACKING (Commit log requirements): Describe our policy: when you
fix a bug, put the "git describe" string of the bug-introducing commit
in your commit log and put the "fixed-in-release version number"
in the NEWS blurb.
2012-04-03 16:14:32 +02:00
Paul Eggert
80bc8651fd
maint: quote 'like this' or "like this", not `like this'
...
* doc/coreutils.texi (Formatting the file names):
coreutils now quotes 'like this'.
* man/help2man:
* src/timeout.c (usage): Quote 'like this' in diagnostics.
* HACKING, Makefile.am, NEWS, README, README-hacking, TODO, cfg.mk:
* doc/Makefile.am, doc/coreutils.texi, m4/jm-macros.m4:
* man/Makefile.am, man/help2man, src/Makefile.am, src/copy.h:
* src/extract-magic, src/ls.c, src/pinky.c, src/pr.c, src/sort.c:
* src/split.c, src/timeout.c, src/who.c, tests/dd/skip-seek-past-file:
* tests/pr/pr-tests: Quote 'like this' in commentary.
* cfg.mk (old_NEWS_hash): Update due to changed old NEWS.
2012-01-22 15:26:38 -08:00
Jim Meyering
5111aa4296
maint: update all copyright year number ranges
...
Run "make update-copyright".
2012-01-01 10:04:06 +01:00
Pádraig Brady
832c85e3f7
doc: describe test control variables
...
* HACKING (Add tests): Mention the variables and default values.
* README-release (Pre-release testing): Mention that setting
the SHELL variable may be required.
Suggested by Bruno Haible.
2011-09-02 11:41:23 +01:00
Ivan Sichmann Freitas
6ab90b53f6
doc: add a vim indentation example
...
HACKING: add a vim example showing how to configure it to follow GNU
indentation in coreutils source files.
2011-07-27 13:51:15 +01:00
Jim Meyering
d95e3c8ceb
doc: clean up HACKING guidelines
...
* HACKING: Remove mention of "indent-tabs-mode: nil", since
we've remove all of those directives. No longer needed.
Remove dated (pre-emacs-23) reference regarding WhiteSpace mode.
2011-01-12 21:21:26 +01:00
Jim Meyering
9d6231ef2a
maint: update all copyright year number ranges
...
Run "make update-copyright".
2011-01-01 22:16:47 +01:00
Paul Eggert
b0097f3d21
coreutils: keep lines within 80-column limits
...
* cfg.mk (LINE_LEN_MAX, FILTER_LONG_LINES): New macros.
(sc_long_lines): New rule.
* HACKING: Use shorter URLs to the same material.
* doc/Makefile.am, doc/coreutils.texi, m4/boottime.m4:
* man/help2man, man/stdbuf.x, src/Makefile.am, src/cat.c, src/copy.c:
* src/cp.c, src/dd.c, src/df.c, src/du.c, src/groups.c, src/install.c:
* src/ls.c, src/md5sum.c, src/mv.c, src/od.c, src/pinky.c, src/ptx.c:
* src/readlink.c, src/remove.c, src/rmdir.c, src/setuidgid.c:
* src/sort.c, src/tail.c, src/touch.c, tests/Coreutils.pm:
* tests/cp/existing-perm-race, tests/cp/perm, tests/cp/preserve-gid:
* tests/du/2g, tests/du/long-from-unreadable, tests/init.sh:
* tests/install/basic-1, tests/ls/nameless-uid:
* tests/ls/readdir-mountpoint-inode, tests/misc/chroot-credentials:
* tests/misc/cut, tests/misc/date, tests/misc/join, tests/misc/md5sum:
* tests/misc/sha1sum, tests/misc/sha224sum, tests/misc/sort:
* tests/misc/sort-continue, tests/misc/sort-files0-from:
* tests/misc/sort-rand, tests/misc/stdbuf, tests/misc/tr:
* tests/misc/uniq, tests/mv/atomic, tests/mv/part-fail:
* tests/mv/part-symlink, tests/mv/sticky-to-xpart, tests/pr/pr-tests:
* tests/rm/fail-2eperm, tests/rm/interactive-always:
Reformat to fit within 80 columns.
* doc/Makefile.am (BAD_POSIX_PERL): New macro.
* doc/coreutils.texi: Reword slightly, to make menus and
index lines shorter.
* src/md5sum.c: Redo --help output so that it fits within 79
columns, since that's a bit more portable and all the other --help
strings fit in 79 columns.
2010-12-28 12:30:42 -08:00
Jim Meyering
56fce1aed7
* HACKING (Add tests): Change example name, "newtest" to "new-test".
...
Not that anyone would confuse with something newt-related, but just
because it is more readable that way.
doc: tweak HACKING
2010-04-16 08:42:47 +02:00
Jim Meyering
36cc6ac787
doc: tweak HACKING
...
* HACKING (Curly braces): Tweak a sentence. Filter a few
paragraphs through "fmt".
2010-04-16 08:21:32 +02:00
Jim Meyering
f8291d0ec4
doc: document our code formatting policy regarding curly braces
...
* HACKING (Curly braces: use judiciously): New section.
2010-04-15 18:52:41 +02:00
Eric Blake
72a0a8264d
maint: apply correct license to auxiliary files
...
* gnulib: Update, for maint.mk improvements.
* HACKING: Use GFDL 1.3, not 1.2.
* NEWS: Likewise.
* README: Likewise.
* cfg.mk (old_NEWS_hash): Update accordingly.
* .gitignore: Ignore file created by 'make update-NEWS-hash'.
2010-01-06 21:05:52 -07:00
Jim Meyering
1aa17dc89b
maint: update all FSF copyright year lists to include 2010
...
Use this command:
git ls-files | grep -v COPYING \
| xargs env UPDATE_COPYRIGHT_USE_INTERVALS=1 \
build-aux/update-copyright
2010-01-01 14:06:47 +01:00
Jim Meyering
ddfcccce51
doc: HACKING: mention the new space-only indentation policy
2009-08-25 09:21:00 +02:00
Jim Meyering
5e778f7c8d
global: convert indentation-TABs to spaces
...
Transformed via this shell code:
t=$'\t'
git ls-files \
| grep -vE '(^|/)((GNU)?[Mm]akefile|ChangeLog)|\.(am|mk)$' \
| grep -vE 'tests/pr/|help2man' \
| xargs grep -lE "^ *$t" \
| xargs perl -MText::Tabs -ni -le \
'$m=/^( *\t[ \t]*)(.*)/; print $m ? expand($1) . $2 : $_'
2009-08-25 09:21:00 +02:00
Jim Meyering
4612670f46
doc: point to Guile's ChangeLog-writing guidelines
...
* HACKING (Commit log requirements): Point to Guile's
http://www.gnu.org/software/guile/changelogs/guile-changelogs_3.html .
Mention that a bit of prose can be welcome.
2009-07-14 20:43:49 +02:00
Jim Meyering
d8243c25cd
doc: HACKING: minor adjustments, additions
...
* HACKING (Amending...): Remove spurious "-e" used with commit --amend.
(log message policy): Mention the 72-column limit.
"build:" and "maint:" are common prefixes, these days.
2009-06-03 18:30:40 +02:00
Jim Meyering
18db64ba7e
doc: HACKING: mention the GNU Coding Standards
...
* HACKING (Add documentation): Add a link to the GCS.
2009-06-02 16:35:14 +02:00
Jim Meyering
088a7ca9b1
maint: HACKING: mention a few more useful git commands
...
* HACKING (Miscellaneous useful git commands): Add a few.
2009-05-17 17:51:13 +02:00
Ralf Wildenhues
0d61f144a3
policy: use git to help avoid trailing white space
...
* HACKING (Avoid trailing white space): Describe how git can help.
2009-03-04 06:19:49 +01:00
Jim Meyering
d88c9f95e3
* HACKING: avoid trailing white space
2009-02-27 23:05:07 +01:00
Jim Meyering
0a3f944791
doc: explain how to recover from changes committed to master
...
* HACKING: A beginner's commit-to-master is so common,
and causes enough confusion, that we describe how to recover.
2009-02-18 15:40:53 +01:00
Jim Meyering
fa391362e1
maint: add copyright notices
...
* HACKING: Add copyright notice.
* tests/test-lib.sh: Likewise.
2009-02-18 15:40:44 +01:00
Pádraig Brady
48cae1e864
maint: mention how to run a single test in HACKING docs
...
* HACKING: Give an example of how to run a test in isolation.
* README: Fix/simplify example for running a single test.
* README-hacking: Reference the HACKING file.
2009-02-13 11:13:33 +00:00
Jim Meyering
8b09875b59
doc: HACKING: reference http://www.gnu.org/licenses/why-assign.html
...
Suggestion from Patrick Schoenfeld.
2008-11-17 11:16:19 +01:00
Jim Meyering
186b45aaed
* HACKING: describe how to find a misplaced change-set
2008-07-16 15:29:04 +02:00
Jim Meyering
556fbb5721
* HACKING: use shorter "-1" (over HEAD~1) with git format-patch
2008-06-26 21:08:22 +02:00
Bo Borgerson
3435bb7f40
HACKING: Add section for tips on reducing translator workload.
...
* HACKING (Be nice to translators): New section.
Add Jim's suggestion to avoid changing translatable strings if possible.
2008-06-17 08:29:23 +02:00
Jim Meyering
837bb31803
update HACKING guidelines
...
* HACKING: Don't suggest --signoff; it's redundant.
(log requirements): Specify preferred forms.
Mention preference for "<" over ">".
Mention the "const placement" preference.
2008-06-15 16:01:29 +02:00
Jim Meyering
0bf3eb3682
make HACKING slightly more generic
...
* HACKING: remove some uses of "coreutils"
Point to git's own SubmittingPatches URL.
2008-05-16 10:08:56 +02:00
Bo Borgerson
bbc49eb536
Add Daniel Dunbar's lcov instructions to HACKING
...
* HACKING: New section `Finding things to do', points to TODO file and
gives instructions on generating an html coverage report as provided by
Daniel Dunbar.
* TODO: Add item for improving test coverage. Point back to HACKING.
Signed-off-by: Bo Borgerson <gigabo@gmail.com >
2008-04-30 16:09:33 +02:00
Jim Meyering
cca6a8d7e5
tweak HACKING advice
2008-04-27 21:31:08 +02:00
Jim Meyering
184a0298f3
HACKING: rename README-contribution-guidelines
...
README-contribution-guidelines: Rename to ..
HACKING: ...this.
2008-04-02 09:08:08 +02:00