[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH attr] doc: drop obsolete PORTING guide
From: |
Mike Frysinger |
Subject: |
[PATCH attr] doc: drop obsolete PORTING guide |
Date: |
Sat, 13 Jan 2024 21:09:08 -0500 |
Bug: https://savannah.nongnu.org/bugs/index.php?64987
---
README | 3 --
doc/Makemodule.am | 3 +-
doc/PORTING | 86 -----------------------------------------------
3 files changed, 1 insertion(+), 91 deletions(-)
delete mode 100644 doc/PORTING
diff --git a/README b/README
index 738d1e316927..aa08608acbbb 100644
--- a/README
+++ b/README
@@ -8,6 +8,3 @@ install configuration steps.
Refer to the xattr(7) manual page for general extended attribute
(EA) information and references to other EA manual pages.
-
-For more information on the build process, please refer to
-the doc/PORTING document.
diff --git a/doc/Makemodule.am b/doc/Makemodule.am
index 8deee44c0a9f..3733dd0d1162 100644
--- a/doc/Makemodule.am
+++ b/doc/Makemodule.am
@@ -1,7 +1,6 @@
dist_doc_DATA += \
doc/CHANGES \
doc/COPYING \
- doc/COPYING.LGPL \
- doc/PORTING
+ doc/COPYING.LGPL
EXTRA_DIST += \
%D%/INSTALL
diff --git a/doc/PORTING b/doc/PORTING
deleted file mode 100644
index 5348a263f27a..000000000000
--- a/doc/PORTING
+++ /dev/null
@@ -1,86 +0,0 @@
-
-1. unpack the source tarball and cd to the resulting dir
-
-2. # autoconf
- this reads configure.in and generates the ./configure script
-
-3. # ./configure
- this probes your system and then, for each "file" named
- in the AC_OUTPUT() macro near the end of configure.in,
- read "file".in and generate "file". Variables named @somevariable@
- will be substituted with literal values.
-
-4. step (3) produces several files. These files are generated by
- configure from their respective .in file in the same directory.
- You should have a read of these generated files and diff them
- against their respective .in files to see what was substituted
- by configure.
-
- src/include/builddefs
- common definitions for the build environment. This is included
- by all Makefiles, in conjunction with src/include/buildrules.
- Note that most autoconf/configure build environments generate
- Makefile (from Makefile.in) in every src dir. Instead, we
- generate builddefs, and then include it in every Makefile.
-
- src/include/platform_defs.h
- header containing conditional macros defining the C run-time
- environment discovered by the configure script.
-
-5. read some or all of the GNU tool chain documentation
- GNU make :
- https://www.gnu.org/software/make/manual/
- autoconf :
- https://www.gnu.org/software/autoconf/manual/
- libtool :
- https://www.gnu.org/software/libtool/manual/
- gcc/g++ :
- https://gcc.gnu.org/onlinedocs/
-
-6. Makefiles and build environment
- First have a look at some Makefiles
-
- example using SUBDIRS : attr/Makefile
- example static library: attr/libattr/Makefile
- example command : attr/getfattr/Makefile
-
- All Makefiles must define TOPDIR as the root of the project. This
- allows other stuff to be found relative to $(TOPDIR).
-
- All Makefiles should have the following structure, which is
- much like commondefs and commonrules in the IRIX build environment, e.g.
-
- # ----------------------------------------------------------------------
- # TOPDIR must point to the root of the project
- # The builddefs file defines lots of things. Read it.
- TOPDIR = ..
- include $(TOPDIR)/include/builddefs
-
- # first rule should always be "default"
- default : sometarget
- commands to build targets, if necessary
-
- # $(BUILDRULES) is defined in builddefs and includes rules for
- # descending subdirs, building targets and installation rules
- include $(BUILDRULES)
-
- install : default
- $(INSTALL) sometargets somewhere
- # ----------------------------------------------------------------------
-
-7. packaging
-
- # ./Makepkgs
- this script generates all of the packages supported - each has a
- subdirectory below attr/package where knowledge specific to each
- package type is maintained.
-
- The script produces logs of each stage of the build (this info is
- also echoed to the screen when the "verbose" option is provided):
-
- attr/Logs/configure - `autoconf; ./configure' output
- attr/Logs/default - `make default' output
- attr/Logs/dist - `make package dist' output
-
- On successful completion, the script echoes the names of packages
- successfully generated.
--
2.43.0
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH attr] doc: drop obsolete PORTING guide,
Mike Frysinger <=