diff options
author | Werner Lemberg <wl@gnu.org> | 2013-12-22 09:38:14 +0100 |
---|---|---|
committer | Werner Lemberg <wl@gnu.org> | 2013-12-22 09:38:14 +0100 |
commit | 1c975b79714b0d861a9a32c30921c7236dcbc15a (patch) | |
tree | 63ea0a3cedf69b08e7692af8002b9a1951fe51dd /README | |
parent | 290eaaac6cfc33856cd683838accc72ccf3e5a84 (diff) | |
download | groff-git-1c975b79714b0d861a9a32c30921c7236dcbc15a.tar.gz |
Update top-level documentation regarding git repository and bug tracker.
Diffstat (limited to 'README')
-rw-r--r-- | README | 85 |
1 files changed, 39 insertions, 46 deletions
@@ -1,11 +1,11 @@ Copyright (C) 1989-2006, 2008, 2009, 2012-2013 Free Software Foundation, Inc. - Last Update: 08 Dec 2013 + Last Update: 22 Dec 2013 - Copying and distribution of this file, with or without modification, - are permitted in any medium without royalty provided the copyright - notice and this notice are preserved. + Copying and distribution of this file, with or without + modification, are permitted in any medium without royalty provided + the copyright notice and this notice are preserved. This is the GNU `groff' document formatting system. The version number is given in the file VERSION. @@ -19,11 +19,12 @@ version of the Berkeley `-me' macros, the enhanced version `gxditview' of the X11 `xditview' previewer, and an implementation of the `-mm' macros contributed by Joergen Haegg (jh@axis.se). -See the file `INSTALL' for instructions on how to install from a -release or snapshot tarball. You will require a C++ compiler. +See the file `INSTALL' for instructions on how to install from a +release. You will require a C++ compiler. The file `INSTALL.REPO' contains supplementary instructions for -biuilding directly from a clone of the repository. +biuilding directly from a clone of the repository or a snapshot +tarball. The file `NEWS' describes recent user-visible changes to `groff'. @@ -39,28 +40,17 @@ useful for groff. The most recent released version of `groff' is always available by anonymous ftp from `ftp.gnu.org' in the directory `gnu/groff'. -The current development version of `groff' is available from a -repository which you can find through the Savannah project page for groff: +The current development version of `groff' is available from a git +repository at - http://savannah.gnu.org/projects/groff + https://savannah.gnu.org/git/?group=groff -Alternatively, you can download snapshots (which are updated twice a -day). The complete `groff' source as a single file is available at +To view the git repository in your browser, go to - http://groff.ffii.org/groff/devel/groff-current.tar.gz + http://git.savannah.gnu.org/cgit/groff.git -A diff file relative to `groff-<version>', the latest official `groff' -release, is available at - - http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz - -Assuming that `groff-<version>.tar.gz' and -`groff-<version>-current.diff.gz' are in the same directory, do the -following to apply the diff file: - - tar xzvf groff-<version>.tar.gz - cd groff-<version> - gunzip -c ../groff-<version>-current.diff.gz | patch -p1 +There you can also download snapshots; simply click on a commit entry +line to get the URL. Depending on your requirements, you may need at least some of the following tools to build `groff' directly from its source: @@ -73,19 +63,19 @@ following tools to build `groff' directly from its source: bison >= 1.875b or byacc Note that `texinfo' and `bison' or `byacc' are required only for -building from repository sources (either a checked out working copy, or a -daily snapshot). They are not required for building from a stable -release tarball. Also note that the version numbers stated are the -minimum supported. No version of `texinfo' < 4.8 works, and the +building from repository sources (either a checked out working copy, +or a daily snapshot). They are not required for building from a +stable release tarball. Also note that the version numbers stated are +the minimum supported. No version of `texinfo' < 4.8 works, and the original release of `bison' 1.875 is known not to work; you *may* find that `bison' releases < 1.875 work, but in case of difficulty, please update to a later version *before* posting a bug report. -For *all* sources, you need ghostscript for creation of either `PDF' or -`HTML' output; the `netpbm' and `psutils' packages are required only -for `HTML' output (and for compilation from the repository). If you don't -intend to produce output in either of these formats, then these -packages are unnecessary. +For *all* sources, you need ghostscript for creation of either `PDF' +or `HTML' output; the `netpbm' and `psutils' packages are required +only for `HTML' output (and for compilation from the repository). If +you don't intend to produce output in either of these formats, then +these packages are unnecessary. Additionally, producing `PDF' output directly with the `gropdf' device needs a working installation of Perl. The same is true for the `chem' @@ -101,20 +91,24 @@ your system must be installed, otherwise `groff' does not install `gxditview' and the `-TX*' devices. In Debian, the developer packages are `libxaw7-dev' and `libxmu-dev'. -Please report bugs using the form in the file `BUG-REPORT'; the idea -of this is to make sure that FSF has all the information it needs to -fix the bug. At the very least, read the `BUG-REPORT' form and make -sure that you supply all the information that it asks for. Even if -you are not sure that something is a bug, report it using -`BUG-REPORT': this enables us to determine whether it really is a bug -or not. +Please report bugs using the bug tracker available from the project +page at + + https://savannah.gnu.org/projects/groff + +Alternatively, but less preferable, you may use the form in the file +`BUG-REPORT'; the idea of this is to make sure that FSF has all the +information it needs to fix the bug. At the very least, read the +`BUG-REPORT' form and make sure that you supply all the information +that it asks for. Even if you are not sure that something is a bug, +report it using `BUG-REPORT': this enables us to determine whether it +really is a bug or not. -Three mailing lists are available: +Two mailing lists are available: - bug-groff@gnu.org for reporting bugs + bug-groff@gnu.org for reporting bugs and following bug + reports groff@gnu.org for general discussion of groff - groff-commit@gnu.org a read-only list showing commitments - to the groff repository To subscribe, send a mail to <list>-request@<domain> (example: groff-request@gnu.org for the `groff' list) with the word `subscribe' @@ -123,7 +117,6 @@ Alternatively, you may subscribe by visiting the web pages at http://lists.gnu.org/mailman/listinfo/bug-groff http://lists.gnu.org/mailman/listinfo/groff - http://lists.gnu.org/mailman/listinfo/groff-commit Each of these web pages also provides a link to a browseable archive of postings to the corresponding mailing list. |