[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * README-hacking: Add agendum for next release *
From: |
Gavin D. Smith |
Subject: |
branch master updated: * README-hacking: Add agendum for next release * README: Revise - https for URL's, mention LaTeX and EPUB 3 output, info.texi not part of Texinfo distribution, prefer "texi2any" to "makeinfo". |
Date: |
Mon, 24 Oct 2022 07:07:07 -0400 |
This is an automated email from the git hooks/post-receive script.
gavin pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new 627003ae9d * README-hacking: Add agendum for next release * README:
Revise - https for URL's, mention LaTeX and EPUB 3 output, info.texi not part
of Texinfo distribution, prefer "texi2any" to "makeinfo".
627003ae9d is described below
commit 627003ae9deb2c41a9774f07a3698f01973c3ff9
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Mon Oct 24 12:06:41 2022 +0100
* README-hacking: Add agendum for next release
* README: Revise - https for URL's, mention LaTeX and EPUB 3 output,
info.texi not part of Texinfo distribution, prefer "texi2any" to
"makeinfo".
---
ChangeLog | 7 +++++++
README | 64 ++++++++++++++++++++++++++--------------------------------
README-hacking | 3 +++
3 files changed, 39 insertions(+), 35 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 609fefed62..12bafe82bb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2022-10-24 Gavin Smith <gavinsmith0123@gmail.com>
+
+ * README-hacking: Add agendum for next release
+ * README: Revise - https for URL's, mention LaTeX and EPUB 3 output,
+ info.texi not part of Texinfo distribution, prefer "texi2any" to
+ "makeinfo".
+
2022-10-23 Patrice Dumas <pertusus@free.fr>
* Pod-Simple-Texinfo/prove.sh: remove -w from prove arguments for old
diff --git a/README b/README
index 03b9ac49ef..12996aab0b 100644
--- a/README
+++ b/README
@@ -1,49 +1,49 @@
This is the README file for the GNU Texinfo distribution. Texinfo is
the preferred documentation format for GNU software.
- Copyright 1992-2019 Free Software Foundation, Inc.
+ Copyright 1992-2022 Free Software Foundation, Inc.
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.
-Home page: http://www.gnu.org/software/texinfo/
- Including links to Texinfo-related programs not part of this package.
+Home page: https://www.gnu.org/software/texinfo/
-Primary distribution point: http://ftp.gnu.org/gnu/texinfo/
- automatic mirror redirection: http://ftpmirror.gnu.org/texinfo/
- mirror list: http://www.gnu.org/prep/ftp.html
+Primary distribution point: https://ftp.gnu.org/gnu/texinfo/
+ automatic mirror redirection: https://ftpmirror.gnu.org/texinfo/
+ mirror list: https://www.gnu.org/prep/ftp.html
Texinfo is a documentation system that uses a single source to produce
many forms of output:
- a PDF or DVI document (via the TeX typesetting system) with the normal
features of a book, including sectioning, cross references, indices, etc.
-- an Info file with analogous features to make documentation browsing easy.
-- a plain text (ASCII) file.
-- an HTML output file suitable for use with a web browser.
-- a Docbook file.
-- a XML file transliterating the source with a Texinfo DTD.
+- an Info file with analogous features
+- a plain text (ASCII) file
+- HTML output suitable for use with a web browser
+- an EPUB 3 e-book
+- a LaTeX file, which can then be used to create a PDF
+- a Docbook file
See ./INSTALL* for installation instructions.
-To get started with Texinfo, best is to read the Texinfo manual;
-it is online at http://www.gnu.org/software/texinfo/manual/texinfo.
+To get started with Texinfo, you can read the Texinfo manual
+online at https://www.gnu.org/software/texinfo/manual/texinfo.
+
If you don't have Internet access, you can read the manual locally:
- first, build the distribution.
- then, for HTML, run: make -C doc html
- and you can start reading at doc/texinfo.html/index.html.
+ and you can start reading at doc/texinfo_html/index.html.
- for PDF, if you have a working TeX, run: make -C doc pdf
-- for Info, you can read a tutorial on reading Info files:
- ./info/ginfo doc/info
+- for Info, you can read the manual:
+ ./info/ginfo doc/info-stnd
and/or read the Texinfo manual:
./info/ginfo doc/texinfo
Texinfo mailing lists and archives:
-- http://lists.gnu.org/mailman/listinfo/bug-texinfo
+- https://lists.gnu.org/mailman/listinfo/bug-texinfo
for bug reports, enhancement suggestions, technical discussion.
-- http://lists.gnu.org/mailman/listinfo/help-texinfo
+- https://lists.gnu.org/mailman/listinfo/help-texinfo
for authoring questions and general discussion.
-There are no corresponding newsgroups.
Bug reports:
Please include enough information for the maintainers to reproduce the
@@ -55,15 +55,12 @@ problem. Generally speaking, that means:
- unusual options you gave to configure, if any (try ./config.status --help).
- anything else that you think could be helpful.
-Patches are most welcome; if possible, please make them with diff -c and
-include ChangeLog entries.
+Patches are welcome; if possible, please make them with diff -c or
+git diff and include ChangeLog entries.
See README-hacking for information on the Texinfo development
environment -- any interested parties are welcome. If you're a
-programmer and wish to contribute, this should get you started. If
-you're not a programmer, you can still make significant contributions by
-writing test cases, checking the documentation against the
-implementation, etc.
+programmer and wish to contribute, this should get you started.
This distribution includes the following files, among others:
README This file.
@@ -72,17 +69,14 @@ This distribution includes the following files, among
others:
INSTALL Texinfo-specific installation notes.
NEWS Summary of new features by release.
-Texinfo documentation files (in ./doc):
- texinfo.texi Describes the Texinfo language and many
+Texinfo documentation files
+ doc/texinfo.texi Describes the Texinfo language and many
of the associated tools. It tells how to use
Texinfo to write documentation, how to use
- Texinfo mode in GNU Emacs, TeX,
- texi2any/makeinfo, and much else.
-
- info.texi Describes how to read manuals in Info.
- This document also comes as part of GNU Emacs.
+ Texinfo mode in GNU Emacs, TeX, texi2any, and
+ much else.
- info-stnd.texi How to use the standalone GNU Info reader that is
+ doc/info-stnd.texi How to use the standalone GNU Info reader that is
included in this distribution (./info).
Printing-related files:
@@ -99,7 +93,7 @@ Source directories:
gnulib/ Support files from Gnulib.
info/ Standalone Info reader.
install-info/ Maintain the Info dir file.
- tp/ Texinfo Parser in Perl, includes texi2any/makeinfo.
+ tp/ Texinfo Parser in Perl, includes texi2any.
texindex/ The `texindex' program that generates
sorted indices used by TeX when
typesetting a file for printing.
@@ -118,7 +112,7 @@ Installation support:
build-aux/ Common files.
The util/ directory contains a few other scripts, e.g., examples of
-using makeinfo in various ways. See util/README.
+using texi2any in various ways. See util/README.
Finally, the contrib/ directory contains additional files from users
provided for your reading and/or hacking pleasure. They aren't part of
diff --git a/README-hacking b/README-hacking
index aa6c8c49e7..6bee8dde28 100644
--- a/README-hacking
+++ b/README-hacking
@@ -318,6 +318,9 @@ including:
pod2html $txi/Pod-Simple-Texinfo/pod2texi.pl \
| grep -Fv 'rev="made"' >manual/pod2texi.html
+check for http links that should be changed to https - then delete
+this item
+
Build web documentation with
make -C doc wwwdoc-build
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * README-hacking: Add agendum for next release * README: Revise - https for URL's, mention LaTeX and EPUB 3 output, info.texi not part of Texinfo distribution, prefer "texi2any" to "makeinfo".,
Gavin D. Smith <=