commit 8ed77e034ea97f723a61340189dd377136e9e3d9
parent b1899a0c43e8d388164044bbf169ab2c6a91861e
Author: Roberto E. Vargas Caballero <k0ga@shike2.com>
Date: Tue, 29 Oct 2024 22:11:53 +0100
doc: Add basic info for the tools
These brief information in the README is only a minimal description
of the different tools that are shipped as part of scc. Proper man
pages will be written with detailed information of every tool.
Diffstat:
| M | README | | | 60 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 60 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -23,6 +23,66 @@ from a amd64-linux-gnu host system:
The build system of scc supports parallel builds that will reduce
dramatically the build time.
+After a successful install the following programs are installed:
+
+ - gcc-scc: A wrapper shell script to use system cc and ld
+ with the scc libc.
+
+ - scc: A wrapper shell script that allows the execution
+ of scc-cc from any directory independently of the PREFIX
+ used in the build.
+
+ - scc-addr2line: A work in progress to implement a tool
+ that is able to translate a hexadecimal address into
+ a symbol.
+
+ - scc-ar: An archiver commonly used for static libraries.
+ It is binary format agnostic, and it does not create an
+ index independently of the objects stored in it. Both,
+ coff and elf specify that an index should be created
+ when the archive is created, but as this is not done
+ by scc-ar, if you need an index you have to call
+ directly to scc-ranlib.
+
+ - scc-cc: Driver of the compiler. It uses the compile
+ time option PREFIX to locate helper programs and
+ library files. This value can be overriden by the
+ `SCCPREFIX` environment variable.
+
+ - scc-cpp: A wrapper shell script that only preprocess
+ the file, and it allows the execution from any
+ directory independently of the PREFIX used in the
+ build.
+
+ - scc-ld: A work in progress to implement a linker for
+ the scc toolchain.
+
+ - scc-make: An implementation of POSIX make as defined
+ in POSIX 2018. No POSIX 2024 support is planned in a
+ near future.
+
+ - scc-nm: An implementation of POSIX nm.
+
+ - scc-objcopy: A work in progress of a GNU objcopy alike
+ program.
+
+ - scc-objdump: A work in progress of a GNU objdump alike
+ program.
+
+ - scc-ranlib: An implementation of a classical UNIX ranlib.
+ While ranlib is not specified in current POSIX standards
+ it is implemented in almost all the UNIX alike systems.
+ In the case of scc, the ar implementation does not add
+ index files by default, such a tool like ranlib is
+ required.
+
+ - scc-size: An implementation of POSIX size.
+
+ - scc-strip: An implementation of POSIX strip.
+
+The toolchain has a good support for COFF files, and a basic support
+for ELF files.
+
config.mk
---------
