Import xPack OpenOCD 0.12.0-7 and GNU Make 4.4.1 from x86_64-w64-mingw32.
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
Texinfo authors.
|
||||
|
||||
Copyright 2003-2024 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.
|
||||
|
||||
Karl Berry all files.
|
||||
Per Bothner js/*
|
||||
Torsten Bronger texinfo.dtd.
|
||||
Bob Chassell texinfo.tex, original texinfo.txi.
|
||||
Akim Demaille texi2dvi, util/* tests.
|
||||
Patrice Dumas texinfo.txi, tp author.
|
||||
Brian Fox all info/* files, info-stnd.texi.
|
||||
Noah Friedman original texi2dvi.
|
||||
Oleg Katsitadze doc/*
|
||||
Matthieu Lirzin js/*
|
||||
Sergey Poznyakoff all files.
|
||||
Arnold Robbins literate (texi+awk) texindex.
|
||||
Andreas Schwab texinfo.tex, configure.ac
|
||||
Gavin Smith all files.
|
||||
Richard Stallman original texinfo.tex, install-info.c,
|
||||
texindex.c, texinfo.txi.
|
||||
Zack Weinberg texinfo.tex: @macro implementation.
|
||||
Ralf Wildenhues util/gendocs.sh, doc/texinfo.txi,
|
||||
Makefile.am, configure.ac.
|
||||
Eli Zaretskii all files.
|
||||
|
||||
See http://translationproject.org/team/index.html for the
|
||||
translation teams for a given language LL.
|
||||
|
||||
Many files included in the Texinfo distribution are copied from other
|
||||
locations, no author information is given for those. See util/srclist*.
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,120 @@
|
||||
This is the README file for the GNU Texinfo distribution. Texinfo is
|
||||
the preferred documentation format for GNU software.
|
||||
|
||||
Copyright 1992-2024 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: https://www.gnu.org/software/texinfo/
|
||||
|
||||
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
|
||||
- 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, 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.
|
||||
- for PDF, if you have a working TeX, run: make -C doc pdf
|
||||
- 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:
|
||||
- https://lists.gnu.org/mailman/listinfo/bug-texinfo
|
||||
for bug reports, enhancement suggestions, technical discussion.
|
||||
- https://lists.gnu.org/mailman/listinfo/help-texinfo
|
||||
for authoring questions and general discussion.
|
||||
|
||||
Bug reports:
|
||||
Please include enough information for the maintainers to reproduce the
|
||||
problem. Generally speaking, that means:
|
||||
- the contents of all input files needed to reproduce the bug (crucial!).
|
||||
- a statement of the problem and any samples of the erroneous output.
|
||||
- the version number of Texinfo and the program(s) involved (use --version).
|
||||
- hardware and operating system information (uname -a).
|
||||
- unusual options you gave to configure, if any (try ./config.status --help).
|
||||
- anything else that you think could be helpful.
|
||||
|
||||
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.
|
||||
|
||||
This distribution includes the following files, among others:
|
||||
README This file.
|
||||
README-hacking Texinfo developer information.
|
||||
|
||||
INSTALL Texinfo-specific installation notes.
|
||||
NEWS Summary of new features by release.
|
||||
|
||||
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, and
|
||||
much else.
|
||||
|
||||
doc/info-stnd.texi How to use the standalone GNU Info reader that is
|
||||
included in this distribution.
|
||||
|
||||
Printing-related files:
|
||||
doc/texinfo.tex This implements Texinfo in TeX, to typeset a
|
||||
Texinfo file into a DVI or PDF file.
|
||||
|
||||
util/texi2dvi This is a shell script for producing an
|
||||
indexed DVI file using TeX and texindex.
|
||||
|
||||
util/texi2pdf Generate PDF (wrapper for texi2dvi).
|
||||
|
||||
Source directories:
|
||||
djgpp/ Support for compiling under DJGPP.
|
||||
gnulib/ Support files from Gnulib.
|
||||
info/ Standalone Info reader.
|
||||
install-info/ Maintain the Info dir file.
|
||||
js/ Enhanced browsing of HTML manuals with JavaScript.
|
||||
tp/ Texinfo Parser in Perl, includes texi2any.
|
||||
texindex/ The `texindex' program that generates
|
||||
sorted indices used by TeX when
|
||||
typesetting a file for printing.
|
||||
|
||||
Translation support:
|
||||
po/ Strings of the programs.
|
||||
po_document/ Strings in generated Texinfo documents.
|
||||
|
||||
Installation support:
|
||||
Makefile.am Read by Automake to create a Makefile.in.
|
||||
Makefile.in Read by configure to make a Makefile,
|
||||
created by Automake.
|
||||
configure.ac Read by Autoconf to create `configure'.
|
||||
configure Configuration script for local conditions,
|
||||
created by Autoconf.
|
||||
build-aux/ Common files.
|
||||
|
||||
The util/ directory contains a few other scripts, e.g., examples of
|
||||
using texi2any in various ways. See util/README.
|
||||
|
||||
Some files in this package have their copyright years stated as a range
|
||||
('2008-2010') rather than listed as individual years ('2008, 2009,
|
||||
2010').
|
||||
@@ -0,0 +1,625 @@
|
||||
Copyright 2002-2024 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.
|
||||
|
||||
The development sources for GNU Texinfo are available through git
|
||||
at Savannah:
|
||||
https://savannah.gnu.org/git/?group=texinfo
|
||||
|
||||
See also files:
|
||||
tp/README, tp/t/README, tp/tests/README, TODO, TODO.HTML
|
||||
|
||||
Development tools
|
||||
-----------------
|
||||
|
||||
This distribution uses whatever versions of Automake, Autoconf, and
|
||||
Gettext are listed in NEWS; usually the latest official releases. If
|
||||
you are getting the sources from the development repository (or change
|
||||
configure.ac), you'll need to have these tools installed to (re)build.
|
||||
You'll also need help2man (for building man pages) and gperf (for building
|
||||
"unicase/*" and "uninorm/*" modules from gnulib). If you modify
|
||||
texindex/ti.twjr, you'll need gawk >= 4.0. All of these programs are
|
||||
available from https://ftp.gnu.org/gnu. You'll also need pod2man
|
||||
for building a man page, which should be part of the Perl core
|
||||
distribution.
|
||||
|
||||
After getting the development sources, and installing the tools above,
|
||||
you can run
|
||||
./autogen.sh
|
||||
and then, for example,
|
||||
./configure -C CFLAGS='-g' PERL_EXT_CFLAGS='-g'
|
||||
and then
|
||||
make
|
||||
|
||||
The -C tells configure to cache test results, which usually speeds
|
||||
things up a bit.
|
||||
|
||||
After the initial autogen && configure, simply running make should suffice.
|
||||
|
||||
Gettext or help2man not installed do not cause configure to fail,
|
||||
though configure shows if they were found. This is because a release
|
||||
does not require those tools. Indeed, both prerequisites and
|
||||
result files are shipped in a release, such that the tools are only
|
||||
needed if the prerequisite changed. The tools are needed, however, when
|
||||
building from development sources, as result files are not under version
|
||||
control. Make will fail with an explicit "missing command" for help2man,
|
||||
and with a "command not found" error for a Gettext utility command.
|
||||
|
||||
Running make in one particular subdirectory is possible, for example
|
||||
make -C info. However there are interdependencies between the
|
||||
subdirectories, notably on gnulib, so if you don't want to run "make",
|
||||
you may have to run "make -C gnulib/lib" first.
|
||||
|
||||
Additionally, make dist may not work until make has been run at least
|
||||
once, because of rules to create man pages under the man/ directory.
|
||||
|
||||
"make dist" will fail if the use of Perl XS extension modules is
|
||||
disabled and there is no Makefile in the XS subdirectory.
|
||||
|
||||
|
||||
Using git
|
||||
---------
|
||||
|
||||
This section is if you have write access to the git repository.
|
||||
|
||||
Usually commits to the git repository should include a ChangeLog
|
||||
entry. Please follow the existing style (the GNU Coding Standards
|
||||
has a guide).
|
||||
|
||||
You can automatically use the contents of the most recent ChangeLog
|
||||
entry with a git commit hook .git/hooks/prepare-commit-msg
|
||||
|
||||
------------------------------------
|
||||
#!/bin/sh
|
||||
|
||||
# $1 - file that contains commit log message
|
||||
# $2 - source of commit message
|
||||
|
||||
outfile="$1"
|
||||
|
||||
case $2 in
|
||||
message|template|merge|squash|commit)
|
||||
;;
|
||||
*)
|
||||
# Use latest ChangeLog entry as commit message
|
||||
sed -n -e '1,/^\w*$/d' -e '/^[^ ]/q' -e '{s/^ //;p}' ChangeLog >"$outfile"
|
||||
;;
|
||||
esac
|
||||
------------------------------------
|
||||
|
||||
If you are frequently applying patches sent by other people, the following
|
||||
may be useful to have in .git/hooks/post-commit to get the --author
|
||||
information from the ChangeLog:
|
||||
|
||||
------------------------------------
|
||||
#!/bin/sh
|
||||
|
||||
# post-commit
|
||||
|
||||
# avoid recursion
|
||||
test $IN_GIT_HOOK_POST_COMMIT && exit 0
|
||||
export IN_GIT_HOOK_POST_COMMIT=1
|
||||
|
||||
# Get author from latest ChangeLog entry. Remove date, leading and trailing
|
||||
# spaces, and condense multiple spaces to 1.
|
||||
CL_author=$(head -n 1 ChangeLog | sed -e 's/^[[:digit:]-]*//' -e 's/^ *//' -e 's/ *$//' -e 's/ \+/ /')
|
||||
|
||||
# Get author from last commit
|
||||
HEAD_author=$(git log -1 --pretty=format:'%an <%ae>')
|
||||
|
||||
if test "$CL_author" != "$HEAD_author" ; then
|
||||
git commit --amend --author="$CL_author" --reuse-message=HEAD
|
||||
|
||||
echo "post-commit: changed author from '$HEAD_author'"
|
||||
echo "post-commit: to '$CL_author'."
|
||||
echo "post-commit: to override, run:"
|
||||
echo "post-commit: IN_GIT_HOOK_POST_COMMIT=1 git commit --amend -C HEAD --author=\"$HEAD_author\""
|
||||
fi
|
||||
------------------------------------
|
||||
|
||||
Please ensure they have appropriate copyright assignments in place with
|
||||
the FSF before committing other people's changes, and check with a
|
||||
maintainer if unsure.
|
||||
|
||||
When unable to push commits due to other commits being made, please
|
||||
use "git pull --rebase" (the default for "git pull" complicates the
|
||||
git history). To deal with conflicts in the ChangeLog, you should
|
||||
install the git-merge-changelog program.
|
||||
|
||||
You can get better output from "git diff" for Texinfo files by putting
|
||||
the following section in your .gitconfig file:
|
||||
|
||||
[diff "texinfo"]
|
||||
xfuncname = "^(@node .*)$"
|
||||
|
||||
This shows which node each change occurred in.
|
||||
|
||||
|
||||
Gnulib
|
||||
------
|
||||
|
||||
This distribution uses Gnulib (http://www.gnu.org/software/gnulib)
|
||||
to share common files. Gnulib files used in Texinfo are checked in to
|
||||
the repository. A Gnulib directory is setup in two locations, in
|
||||
the main directory and in tp/Texinfo/XS/.
|
||||
|
||||
To update the gnulib files, get a checkout of gnulib in a separate
|
||||
directory, then run, say
|
||||
|
||||
../gnulib/gnulib-tool --add-import
|
||||
|
||||
in your top-level Texinfo directory and
|
||||
|
||||
../../../../gnulib/gnulib-tool --add-import
|
||||
|
||||
under tp/Texinfo/XS. (gnulib-tool is in the gnulib source tree.)
|
||||
|
||||
The currently-used gnulib modules and other gnulib information are
|
||||
recorded in gnulib/m4/gnulib-cache.m4.
|
||||
|
||||
gnulib-tool --add-import may also be used to add another gnulib module:
|
||||
../gnulib/gnulib-tool --add-import other_gnulib_module
|
||||
|
||||
After running gnulib-tool --add-import or otherwise adding modules, it is
|
||||
necessary to check what files were added or removed (e.g., run "git
|
||||
status -u") and add new files to the repository with "git add".
|
||||
Add any new generated files (typically gnulib/lib/foo.h from foo.h.in)
|
||||
to the ignore list in .gitignore.
|
||||
|
||||
When adding new modules, or sometimes even just when upgrading gnulib,
|
||||
it may be necessary to update the LDADD variables in info/Makefile.am or
|
||||
install-info/Makefile.am. Check for any unfamiliar Makefile variables in
|
||||
the output of "gnulib-tool --add-import", and work out which program
|
||||
needs them. You can look at the modules/* files in the gnulib checkout
|
||||
to help work out which gnulib module is demanding which variable.
|
||||
|
||||
For the gnulib checkout in the XS directory, it is just
|
||||
tp/Texinfo/XS/Makefile.am that may need to be updated.
|
||||
|
||||
|
||||
|
||||
Subdirectories in repository
|
||||
----------------------------
|
||||
|
||||
In addition to the subdirectories listed in README, there is the
|
||||
following directory in the source control repository:
|
||||
|
||||
infog/ - HTML-Info reader using WebKitGTK library
|
||||
|
||||
Finally, the contrib/ directory contains additional files from users
|
||||
provided for your reading and/or hacking pleasure. They aren't part of
|
||||
Texinfo proper or maintained by the Texinfo developers.
|
||||
|
||||
|
||||
|
||||
|
||||
About running the Texinfo programs from a development source tree:
|
||||
|
||||
- Once the distribution is built, you can run the compiled programs
|
||||
(info, install-info) out of the build tree without special settings;
|
||||
they don't try to read any installed data files.
|
||||
|
||||
- The texi2dvi script and texinfo.tex can be run as-is, since they
|
||||
are standalone and don't require compilation. For the same reasons,
|
||||
they are officially updated between full Texinfo releases, at
|
||||
http://ftpmirror.gnu.org/texinfo.
|
||||
|
||||
- Regarding texi2any (aka makeinfo), you can run tp/texi2any.pl
|
||||
directly. This is the original source file for the program, so it's
|
||||
convenient to be able to make changes and then run it.
|
||||
|
||||
To run the output "tp/texi2any" instead, you can set the environment
|
||||
variable TEXINFO_DEV_SOURCE to 1. Otherwise, it will try to use
|
||||
Texinfo's Perl modules in the installed locations. "tp/texi2any" uses
|
||||
the Perl interpreter found by configure, so you might want to run that
|
||||
instead of texi2any.pl if it's different to the default interpreter in
|
||||
your environment.
|
||||
|
||||
To directly run programs out of source, you should set the top_builddir
|
||||
variable to the top build directory, in order to have compiled modules
|
||||
and translated in-document strings found. If you use scripts with
|
||||
names ending in .pl or .t test files, the source directory obtained
|
||||
from the script name is used to determine the source directories and
|
||||
you do not need to set them explicitely. Otherwise, you may need to
|
||||
set the srcdir and/or the top_srcdir variables.
|
||||
|
||||
|
||||
|
||||
References for working on various parts of the system:
|
||||
|
||||
If you want to delve into making a new backend for the Perl makeinfo,
|
||||
the documentation in tp/Texinfo/Convert/Converter.pm is a good starting
|
||||
point, as it describes the existing backends and other places to look.
|
||||
|
||||
If you want to delve into texinfo.tex, a thorough plain TeX reference
|
||||
is available under the GFDL:
|
||||
TeX by Topic - http://www.eijkhout.net/texbytopic/texbytopic.html
|
||||
Another book on plain TeX, also available under the GFDL, is a GNU package:
|
||||
TeX for the Impatient - http://www.gnu.org/software/teximpatient/
|
||||
Occasionally you may need to know about the details of the PDF format.
|
||||
A reference for this is the PDF reference, Sixth Edition, version 1.7,
|
||||
downloadable at http://www.adobe.com/devnet/pdf/pdf_reference_archive.html
|
||||
|
||||
The texindex program is implemented using the TexiWebJR literate
|
||||
programming system, combining Texinfo and Awk
|
||||
(https://github.com/arnoldrobbins/texiwebjr). Running "make ti.pdf"
|
||||
in the texindex/ subdirectory creates the printable form of the
|
||||
program. All the usual Texinfo output formats are possible.
|
||||
|
||||
|
||||
|
||||
- Updating copyright years in files
|
||||
|
||||
We try to handle updating years in copyright notices automatically to
|
||||
relive people of the burden of remembering to update copyright years when
|
||||
they edit a file for the first time in a new year.
|
||||
|
||||
In a new year, run "make grand-replace" from the top level. Check changes
|
||||
with "git diff" before committing.
|
||||
|
||||
Look for omissions by running, e.g.
|
||||
|
||||
find . \
|
||||
-name autom4te.cache -prune -o \
|
||||
-name .git -prune -o \
|
||||
-wholename ./tp/maintain/lib -prune -o \
|
||||
-name test -prune -o \
|
||||
-name "test-infodir" -prune -o \
|
||||
-name "gnulib" -prune -o \
|
||||
-type f \
|
||||
\( -name '*' \) \
|
||||
-not -name 'Makefile.in' \
|
||||
-not -name Makefile \
|
||||
-not -name "*.m4" \
|
||||
-not -name configure \
|
||||
-not -name "config.*" \
|
||||
-not -name "*~" \
|
||||
-exec perl -wnl -e '/20\d[^4] Free/ && print "$ARGV:$_"' '{}' \;
|
||||
|
||||
at the top level. It's likely that the script doesn't find all the
|
||||
years that should be updated yet.
|
||||
|
||||
|
||||
- Note on "reproducible builds"
|
||||
|
||||
Generation of Texinfo releases has not been checked to be fully
|
||||
reproducible (see https://reproducible-builds.org/).
|
||||
|
||||
However, in the interests of a reproducible distribution, GNU tar is
|
||||
used with certain flags to generate a tar archive file containing input
|
||||
for texi2any tests (by maintain/regenerate_non_ascii_tar_file). GNU tar
|
||||
will only be used with these flags if it is detected that it is available.
|
||||
If other tar programs are used, this archive file will be not bit-for-bit
|
||||
identical.
|
||||
|
||||
|
||||
|
||||
- When close to making a release:
|
||||
|
||||
NYTProf profiling for Perl code
|
||||
* e.g. 'perl -d:NYTProf ../tp/texi2any.pl FILE.texi'. See Devel::NYTProf
|
||||
man page.
|
||||
callgrind profiling for XS code
|
||||
* e.g. 'LD_BIND_NOW=1 valgrind --tool=callgrind perl ../tp/texi2any.pl \
|
||||
FILE.texi' then 'kcachegrind callgrind.out.*'.
|
||||
|
||||
run all tests with valgrind:
|
||||
* in info/t/Init-test.inc, put valgrind in $ginfo, then check t/*.val.log
|
||||
files after running test suite. Note that a small number of tests may
|
||||
report leaks unless info is compiled with CFLAGS='-O0'.
|
||||
* edit install-info/tests/defs.in, uncomment valgrind line and run
|
||||
"./config.status install-info/tests/defs" to regenerate defs.
|
||||
Note that many tests may report leaks unless install-info is compiled
|
||||
with CFLAGS='-O0'.
|
||||
|
||||
* XS modules memory leak check checking with valgrind
|
||||
Add line "use Perl::Destruct::Level level => 1;" to texi2any.pl
|
||||
when running 'valgrind --leak-check=full' to make perl clean it
|
||||
its allocations. Run e.g.
|
||||
valgrind --suppressions=texi2any.supp --log-file=val.log \
|
||||
--leak-check=full \
|
||||
perl ../tp/texi2any.pl ../doc/info-stnd.texi
|
||||
and other input files.
|
||||
|
||||
Add line "use Perl::Destruct::Level level => 1;" to t/test_utils.pl
|
||||
Check tests with e.g.
|
||||
for f in t/*.t ; do valgrind --suppressions=texi2any.supp \
|
||||
--log-file=val.log-${f#t/} \
|
||||
--leak-check=full \
|
||||
perl -w $f ; done
|
||||
(could take 1-2 hours to finish). check log files one by one afterwards.
|
||||
|
||||
Consider doing make check with autovivification turned off to find bugs
|
||||
and make sure that it is possible to turn off autovivification during
|
||||
developpement. It may be interesting to set TEXINFO_XS=omit for this
|
||||
verification. The module turning off autovivification is not in Perl
|
||||
core, so when commiting the lines turning autovivification off should
|
||||
always be commented out.
|
||||
To turn off autovivification, you can use:
|
||||
find tp/Texinfo tp/ext tp/init -type f -name '*.pm' -execdir perl -wpli -e 's/^#no autovivification qw\(fetch delete exists store strict\);/no autovivification qw\(fetch delete exists store strict\);/' '{}' ';'
|
||||
To get back to the default:
|
||||
find tp/Texinfo tp/ext tp/init -type f -name '*.pm' -execdir perl -wpli -e 's/^no autovivification qw\(fetch delete exists store strict\);/#no autovivification qw\(fetch delete exists store strict\);/' '{}' ';'
|
||||
|
||||
Manual testing:
|
||||
. process doc/texinfo-tex-test.texi with TeX and check that output is good.
|
||||
. process some manuals with INFO_JS_DIR and check the JS interface is
|
||||
not broken.
|
||||
. if necessary, check if the HTML customization API can be updated for
|
||||
- lilypond Documentation/lilypond.init
|
||||
- ffmpeg doc/t2h.pm
|
||||
|
||||
check for C compiler warnings by configuring with
|
||||
|
||||
our_CFLAGS='-Wall -Wformat-security -Wstrict-prototypes -Wno-parentheses'
|
||||
./configure "CFLAGS=$our_CFLAGS" "PERL_EXT_CFLAGS=$our_CFLAGS"
|
||||
unset our_CFLAGS
|
||||
|
||||
Not all compiler warnings have to be fixed, though.
|
||||
|
||||
check if po_document/adjust_translations.pl script is still needed (check
|
||||
progress of translations at
|
||||
<https://translationproject.org/domain/texinfo_document.html>, and check
|
||||
whether script is working as intended.)
|
||||
|
||||
check at latest automake/autoconf/gettext/help2man version:
|
||||
. after installing latest version, run
|
||||
AUTOPOINT=true autoreconf -f -v -i
|
||||
followed by reverting unwanted changes
|
||||
. to upgrade gettext, run
|
||||
gettextize --no-changelog -f --po-dir=po --po-dir=po_document --dry-run
|
||||
gettextize --no-changelog -f --po-dir=po --po-dir=po_document
|
||||
after installing new version of gettext.
|
||||
if gettextize makes too many changes that need to be reverted, try
|
||||
autopoint -f --dry-run
|
||||
autopoint -f
|
||||
run "git status -u" to check for new files. revert or remove any
|
||||
*.m4 files that downgrade from a newer serial number (from gnulib)
|
||||
to an older serial number (from gettext). check for duplicate files
|
||||
under build-aux/m4 and gnulib/m4.
|
||||
|
||||
see http://gnu.org/s/gnulib/manual/html_node/gettextize-and-autopoint.html
|
||||
for some hints.
|
||||
|
||||
. also upgrade gettext under tp/Texinfo/XS. run:
|
||||
gettextize -f --po-dir=../../../po --no-changelog
|
||||
and then revert any unwanted changes and remove any unwanted new files.
|
||||
|
||||
. After upgrading automake/autoconf/gettext, run ./autogen.sh
|
||||
and/or "autoreconf --verbose --force --install" to update ancilliary
|
||||
files in build-aux and elsewhere. Check changes before committing.
|
||||
|
||||
. help2man upgrade -
|
||||
make -C man maintainer-clean ; ./config.status man/Makefile ; make -C man
|
||||
. mention new versions in NEWS
|
||||
|
||||
Update gnulib:
|
||||
# Under the top level, and also under tp/Texinfo/XS, which uses
|
||||
# a separate gnulib import.
|
||||
gnulib-tool --add-import
|
||||
'git status -u' and add untracked files
|
||||
|
||||
Use util/srclist-txi for checking files to be copied from gnulib
|
||||
|
||||
Update ppport.h in tp/Texinfo/XS. Update Devel::PPPort via cpan to newest
|
||||
available version, then run:
|
||||
perl -MDevel::PPPort -e'Devel::PPPort::WriteFile'
|
||||
Check that this results in a newer version.
|
||||
|
||||
Check what changes ppport.h reports:
|
||||
perl ppport.h --compat-version=5.8.1 *.xs */*.xs main/get_perl_info.* main/build_perl_info.* main/api_to_perl.* main/call_perl_function.* convert/call_html_perl_function.* convert/build_html_perl_info.* convert/build_html_perl_state.* convert/get_converter_perl_info.* convert/get_html_perl_info.*
|
||||
|
||||
make po-check # update po/POTFILES.in as needed
|
||||
make po_document-check # update po_document/POTFILES.in as needed
|
||||
|
||||
check indices of Texinfo manuals and check for duplicates (with <1> in Info)
|
||||
|
||||
Check "make ccheck" and "make vcheck" work in "doc/refcard".
|
||||
|
||||
Check mentions of configure flags, environment variables etc. in INSTALL are
|
||||
up to date
|
||||
|
||||
Consider running tests of texi2dvi under contrib/nontests
|
||||
|
||||
- Official releases only:
|
||||
make V=1 pdf and fix underfull/overfull boxes.
|
||||
|
||||
-------------------------------------------------------------------------
|
||||
- Distribution checking
|
||||
|
||||
In addition to "make distcheck", there are other build system checks
|
||||
which you can run manually.
|
||||
|
||||
# 'make dist' without 'make'
|
||||
make distclean
|
||||
./configure
|
||||
make dist
|
||||
|
||||
# test make after maintainer-clean
|
||||
./configure
|
||||
make maintainer-clean
|
||||
./configure
|
||||
make
|
||||
|
||||
# test distcheck after maintainer-clean
|
||||
./configure
|
||||
make maintainer-clean
|
||||
./configure
|
||||
make distcheck
|
||||
|
||||
# test distcheck in out-of-source build after maintainer-clean
|
||||
./autogen.sh
|
||||
./configure
|
||||
make maintainer-clean
|
||||
rm -rf build
|
||||
mkdir build
|
||||
cd build
|
||||
../configure
|
||||
make distcheck
|
||||
|
||||
# test that distributed files are not generated in builddir after
|
||||
# maintainer-clean (make distcheck only checks this for distclean).
|
||||
./configure
|
||||
make maintainer-clean
|
||||
rm -rf build
|
||||
mkdir build
|
||||
cd build
|
||||
../configure
|
||||
make
|
||||
make distclean
|
||||
find . -type f
|
||||
|
||||
|
||||
-------------------------------------------------------------------------
|
||||
- Final steps for making a release
|
||||
|
||||
(Keep a copy of README-hacking open in a text editor to update these
|
||||
release instructions.)
|
||||
|
||||
Check on correct branch (master or release/*)
|
||||
|
||||
git switch release/7.1
|
||||
# remove stale generated headers from gnulib
|
||||
git status -u | grep '\.h$' | xargs rm
|
||||
|
||||
* For release/7.1 branch only: need to "rm -f doc/refcard/Makefile.in"
|
||||
after switching to prevent manually written Makefile being clobbered.
|
||||
[Remove this note once release/7.1 no longer relevant.]
|
||||
|
||||
Then rebuild:
|
||||
|
||||
./autogen.sh ; ./configure ; make
|
||||
|
||||
Have a look at the output of "git status -u" to check for files that
|
||||
should be tracked in git or ignored. Check for leftover result
|
||||
files under tp/tests which should be removed.
|
||||
|
||||
check "git stash list" for any work in progress
|
||||
|
||||
Check if "make tex-html-checks" results have been updated under tp/tests.
|
||||
|
||||
check OpenCSW build reports at
|
||||
https://buildfarm.opencsw.org/buildbot/waterfall?category=texinfo
|
||||
(for master branch only)
|
||||
|
||||
Check that TEXINFO_DTD_VERSION has been updated to the next version in
|
||||
configure.ac if the DTD has been modified since the last release.
|
||||
See comments in configure.ac, and run (at the top level) make dtd-check.
|
||||
|
||||
Check "dist-xz" is in the option list in configure.ac (often removed
|
||||
for speed when testing).
|
||||
|
||||
Update version number:
|
||||
update version number in configure.ac, util/texi2dvi, util/texi2pdf,
|
||||
js/info.js
|
||||
version number in txirefcard.tex (offical releases only)
|
||||
(cd texindex ; rm texindex.awk ; make)
|
||||
(cd tp && ./maintain/change_perl_modules_version.sh auto)
|
||||
-- this updates all the version numbers in the Perl modules and
|
||||
in tp/Texinfo/XS/configure.ac
|
||||
check up to date copyright years in files relevant to --version calls
|
||||
(tp/texi2any.pl, info/info.c, install-info/install-info.c, texindex/ti.twjr,
|
||||
Pod-Simple-Texinfo/pod2texi)
|
||||
|
||||
Ensure texinfo.tex, htmlxref.cnf are updated on ftp.gnu.org.
|
||||
Upload texi2dvi, texi2pdf (official releases only)
|
||||
|
||||
* For release/* branch only: propagate htmlxref.cnf from master
|
||||
|
||||
(cd tp ; maintain/regenerate_file_lists.pl) # list all test results
|
||||
|
||||
Ensure TXI_XLATE in doc/Makefile.am matches actual file list.
|
||||
|
||||
Update translations:
|
||||
rsync -Lrtzv translationproject.org::tp/latest/texinfo/ po
|
||||
rsync -Lrtzv translationproject.org::tp/latest/texinfo_document/ \
|
||||
po_document # note the trailing slashes in these commands
|
||||
git status -u # to check for new translations
|
||||
|
||||
run "make -C po check-linguas" and "make -C po_document check-linguas"
|
||||
to check that LINGUAS under po and po_document match actual file list.
|
||||
|
||||
make
|
||||
make update-po
|
||||
( cd po_document ; for f in *.po ; do ./adjust-translations.pl $f ; done )
|
||||
( cd po_document ; make update-po ) # in case po files change again after
|
||||
# last step
|
||||
|
||||
|
||||
- Official releases only:
|
||||
version and date in NEWS.
|
||||
(cd tp && maintain/regenerate_documentlanguages-loc.pl)
|
||||
-- regenerates tp/Texinfo/Documentlanguages.pm (requires Text::CSV)
|
||||
|
||||
notice in ChangeLog.
|
||||
one last "git diff" to check release commit looks good
|
||||
make distcheck
|
||||
(export MALLOC_CHECK_=2; make distcheck) # repeat until clean
|
||||
git commit and push
|
||||
|
||||
(If on a release branch, copy the NEWS message to NEWS on master)
|
||||
|
||||
-------------------------------------------------------------------------
|
||||
|
||||
- To do the actual upload:
|
||||
pkg=texinfo
|
||||
ver=7.0
|
||||
|
||||
then do one of:
|
||||
gnupload --to alpha.gnu.org:$pkg $pkg-$ver.tar.xz #pretest
|
||||
gnupload --to ftp.gnu.org:$pkg $pkg-$ver.tar.{gz,xz} #official
|
||||
gnupload --replace --to ftp.gnu.org:texinfo texi2dvi #official
|
||||
gnupload --replace --to ftp.gnu.org:texinfo texi2pdf #official
|
||||
(Use --user option if not using default key)
|
||||
|
||||
pretest announcement -> bug-texinfo / beebe / platform-testers to try.
|
||||
bcc coordinator@translationproject.org.
|
||||
|
||||
For official releases: send announcement to info-gnu,
|
||||
cc bug-texinfo and bcc coordinator@translationproject.org.
|
||||
news item at savannah.
|
||||
|
||||
# Official releases only: tag source tree
|
||||
git tag texinfo-6.6
|
||||
git push --tags
|
||||
|
||||
# ... set up dtd directory on web pages:
|
||||
cd CVS_WEB/dtd # or wherever webpages checkout is
|
||||
mkdir $ver && cvs add $ver
|
||||
cp $tutil/texinfo.dtd $ver
|
||||
cvs add -kb $ver/texinfo.dtd
|
||||
cvs commit -m$ver $ver
|
||||
|
||||
-------------------------------------------------------------------------
|
||||
|
||||
|
||||
- When official release is out there ...
|
||||
|
||||
Make sure texi2any and texinfo.tex are both installed, then build
|
||||
web documentation with
|
||||
make -C doc wwwdoc-build
|
||||
|
||||
Copy documentation files to web checkout with, e.g.
|
||||
make -C doc \
|
||||
wwwdoc-install www_target=../../CVS_WEB/manual/
|
||||
Check for removed files with, e.g. ls -ltu $(www_target)/*/html_node,
|
||||
and looking at file modification dates for files that have not
|
||||
been replaced, followed by cvs rm -f. Check for added files with
|
||||
"cvs -qn update | less", followed by cvs add for lines beginning "?".
|
||||
When done, run cvs commit.
|
||||
|
||||
update date and version number on home page (texinfo.html) and commit
|
||||
as needed.
|
||||
|
||||
-------------------------------------------------------------------------
|
||||
|
||||
# Official releases only: Contact root@tug.org to update texinfo at tug.org.
|
||||
# If root@tug.org doesn't reply, can try webmaster@tug.org,
|
||||
# or (last resort) board@tug.org.
|
||||
|
||||
|
||||
# ... post-release, or when development resumes:
|
||||
configure.ac, util/texi2dvi: add "dev" to versions for clarity,
|
||||
until it's time to do pretests again.
|
||||
|
||||
Reference in New Issue
Block a user