docs: Prepare release documentation

This commit is contained in:
Niels Grewe 2020-03-29 18:57:34 +02:00
parent 7c3abdca4a
commit a31f416727
No known key found for this signature in database
GPG key ID: 99779549298DB83E
5 changed files with 76 additions and 21 deletions

18
.gitignore vendored
View file

@ -23,4 +23,20 @@ filesystem.make
filesystem.csh
filesystem.sh
gnustep-make-ld.so.conf
GNUstep-strict-v2.conf
GNUstep-strict-v2.conf
Documentation/*.aux
Documentation/*.dvi
Documentation/*.info
Documentation/*.pdf
Documentation/*.ps
Documentation/*.ps.gz
Documentation/*.toc
Documentation/*.vr
Documentation/*.vrs
Documentation/ANNOUNCE
Documentation/INSTALL
Documentation/NEWS
Documentation/README
Documentation/RELEASENOTES
Documentation/version.texi
Documentation/**/*.html

View file

@ -3,7 +3,6 @@
@c %**start of header
@settitle GNUstep Filesystem Hierarchy Document
@c %**end of header
@setcontentsaftertitlepage
@smallbook
@titlepage
@ -24,6 +23,9 @@ any later version published by the Free Software Foundation.
@end titlepage
@contents
@node Top, The System Domain, (dir), (dir)
@chapter GNUstep Filesystem Hierarchy

View file

@ -5,7 +5,6 @@
@settitle GNUstep HOWTO
@c %**end of header
@set HOWTO
@setcontentsaftertitlepage
@smallbook
@titlepage
@ -18,6 +17,7 @@ the GNUstep core libraries.}
Last Update: @today{}
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1996 - 2007 Free Software Foundation, Inc.
@ -28,6 +28,8 @@ any later version published by the Free Software Foundation.
@end titlepage
@contents
@ifinfo
@format
GNUstep HOWTO
@ -58,7 +60,7 @@ any later version published by the Free Software Foundation.
* Additional Installation::
* Tools and Applications::
* Machine Specific::
* Source via SVN::
* Source via git::
@end menu
@node Introduction, Preliminaries, Top, Top
@ -458,31 +460,24 @@ openapp application_name [additional arguments to app]
Good Luck!
@node Machine Specific, Source via SVN, Tools and Applications, Top
@node Machine Specific, Source via git, Tools and Applications, Top
@chapter Machine Specific Instructions
A list of machines that GNUstep works on can be found on the GNUstep
Wiki @url{http://wiki.gnustep.org/index.php/Platform_compatibility}.
@node Source via SVN, , Machine Specific, Top
@chapter Getting Libraries via SVN
@node Source via git, , Machine Specific, Top
@chapter Getting Libraries via git
If you didn't get one of the snapshots, or if you want to be sure to
stay on the bleading edge, then you should get the libraries via SVN. Go
stay on the bleeding edge, then you should get the libraries via git. Go
to @url{http://www.gnustep.org/resources/sources.html} for information on how
to get the sourcecode.
If you haven't already done so, change to the directory, where you
want the source to reside. To checkout all of the GNUstep repository,
type
To fetch all the GNUstep core libraries, you can clone the covenient @file{core}
repository:
@example
svn co http://svn.gna.org/svn/gnustep/modules
@end example
To check out only the @file{core}, which contains all the GNUstep core
libraries:
@example
svn co http://svn.gna.org/svn/gnustep/modules/core
git clone --recurse-submodules https://github.com/gnustep/core.git
@end example
After you have checked out the source you can compile it as
@ -490,10 +485,10 @@ usual. To update the source, go into the directory of the source tree
you want to update, for example, go into 'base', and type:
@example
svn update
git pull
@end example
You don't have to re-checkout after you have the source, just update!
You don't have to re-checkout after you have the source, just pull!
@bye
\bye

View file

@ -4,7 +4,6 @@
@settitle GNUstep Makefile Package
@c %**end of header
@setcontentsaftertitlepage
@smallbook
@setchapternewpage odd
@ -38,6 +37,9 @@ under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation.
@end titlepage
@contents
@page
@c Makefile Package Chapter
@ -973,6 +975,7 @@ additional user library.
LIBRARIES_DEPEND_UPON = -lsimple $(FND_LIBS) $(OBJC_LIBS) $(SYSTEM_LIBS)
@end smallexample
@node GNUmakefile.postamble, Common Variables, GNUmakefile.preamble, Top
@section Global Rules (@file{GNUmakefile.postamble})
@ -1356,6 +1359,29 @@ perform specific operations dependent upon the Objective-C Runtime
library then this variable is the one to check.
@end defvar
@defvar RUNTIME_VERSION
@code{RUNTIME_VERSION} is set to and allows you to override the Objective-C
runtime ABI in use by the clang compiler. Generally, gnustep-make will provide
a sane default for you.Please be aware that mixing different ABIs in the same
binary is not generally supported. Possible values:
@table @samp
@item gcc
This is the classic ABI also implemented by GCC which does not support advanced
features such as ARC or non-fragile instance variables.
@item gnustep-1.8
This is the first iteration of the GNUstep Objective-C ABI, which supports the
advanced features while remaining compatible with the GCC ABI. Requires the
GNUstep Objective-C runtime (libobjc2) 1.8 or later.
@item gnustep-2.0
This version breaks compatibility with the older runtime ABIs in order to
provide better introspection metadata, reduced memory usage and smaller
binaries. Requires the GNUstep Objective-C runtime (libobjc2) 2.0 or later.
@end table
@end defvar
@defvar RUNTIME_DEFINE
@code{RUNTIME_DEFINE} is assigned a preprocessor flag that can be
passed to the compiler which defines a macro based upon the

View file

@ -9,6 +9,22 @@
The currently released version is @samp{@value{GNUSTEP-MAKE-VERSION}}.
@end ifclear
@section Changes in version @samp{2.8.0}
@itemize
@item Better library combo and ABI detection: gnustep-make will now attempt to
detect the optimal library combo and ABI supported by the installed compiler
and Objective-C runtime library. Explicit selection of the runtime ABI is now
possible using the @code{--with-runtime-abi} configure option.
@item Full support for the gnustep-2.0 Objective-C ABI.
@item Support for creating a Git tag and creating a tarball from a git tag
using the @code{git-tag} and @code{git-dist} targets.
@end itemize
@section Changes in version @samp{2.7.0}
Garbage collection support removed