((section 2 "Outdated egg!" (p "This is an egg for CHICKEN 4, the unsupported old release.  You're almost certainly looking for " (int-link "/eggref/5/egg-tarballs" "the CHICKEN 5 version of this egg") ", if it exists.") (p "If it does not exist, there may be equivalent functionality provided by another egg; have a look at the " (link "https://wiki.call-cc.org/chicken-projects/egg-index-5.html" "egg index") ". Otherwise, please consider porting this egg to the current version of CHICKEN.")) (section 2 "egg-tarballs" (toc) (section 3 "Description" (p "A command line tool to generate tarballs and their respective sha1 sums for eggs in " (int-link "/egg/henrietta-cache" "henrietta cache") ".")) (section 3 "Author" (p (int-link "/users/mario-domenech-goulart" "Mario Domenech Goulart"))) (section 3 "Repository" (p (link "https://github.com/mario-goulart/egg-tarballs" "https://github.com/mario-goulart/egg-tarballs"))) (section 3 "Requirements" (section 4 "Eggs" (ul (li (int-link "/egg/simple-sha1" "simple-sha1")))) (section 4 "External tools" (ul (li "GNU tar") (li "gzip")))) (section 3 "Tools" (p "This egg provides two command line tools: " (tt "egg-tarballs") " and " (tt "egg-tarballs-index") ".") (section 4 "egg-tarballs" (p (tt "egg-tarballs") " generates tarballs for egg sources from a cache directory generated by " (int-link "/egg/henrietta-cache" "henrietta-cache") ".") (pre " Usage: egg-tarballs [-verbose] [-version] <henrietta-cache-dir> <tarballs-dir>\n \n Create tarball files under <tarballs-dir>, using egg source files from\n <henrietta-cache-dir>.") (p (tt "<henrietta cache dir>") " is the path to the henrietta cache directory containing egg sources.  " (tt "<tarballs dir>") " is the directory where tarballs will be generated.")) (section 4 "egg-tarballs-index" (p (tt "egg-tarballs-index") " generates index files for eggs.  Index files summarize information about all eggs (see the next subsection for their format).  " (tt "egg-tarballs-index") " generates two index files: a small one (" (tt "index-latest.scm") "), containing information about the latest egg versions only; and a bigger one (" (tt "index.scm") "), containing information about all versions of all eggs.") (pre " $ egg-tarballs-index -h\n Usage: egg-tarballs-index <optional-parameters> <required-parameters>\n \n Create index.scm and index-latest.scm files with metadata about eggs.\n \n <required-parameters>:\n   -chicken-version <chicken version>\n    CHICKEN major version to consider.\n \n   -henrietta-cache-dir\n    Path to the henrietta cache directory.\n \n   -tarballs-dir\n    Path to the tarballs directory.\n \n <optional-parameters>:\n   -O|-out-dir <out dir>\n     Output directory.  If not provided, files are written to the current\n     directory.\n \n   -version:\n     Show the program version and exit.\n \n This program must be run _after_ egg-tarballs, since it needs\n information from tarballs and sum files.") (section 5 "Index file format" (ul (li "The first line is the index format version") (li "the following lines have this format:")) (pre " (<egg> <version> <tarball size> <tarball SHA1 sum> <dependencies> <test dependencies>)")))) (section 3 "Notes" (ul (li "Starting on version 1.0.0, " (int-link "/egg/henrietta-cache" "henrietta-cache") " uses a new cache format (the egg sources directory layout no longer contains the " (tt "tags") " directory).  The support for the new cache format has been added to egg-tarballs 0.5.0 (it also supports the old format)."))) (section 3 "License" (pre "Copyright (c) 2011-2024, Mario Domenech Goulart\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\nRedistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n\nRedistributions in binary form must reproduce the above copyright\nnotice, this list of conditions and the following disclaimer in the\ndocumentation and/or other materials provided with the distribution.\n\nNeither the name of the author nor the names of its contributors may\nbe used to endorse or promote products derived from this software\nwithout specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\nFOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\nCOPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\nINDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\nHOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\nSTRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\nARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\nOF THE POSSIBILITY OF SUCH DAMAGE.")) (section 3 "Version history" (section 5 "version 1.0.1 (2024-10-04)" (ul (li "Fix version number"))) (section 5 "version 1.0.0 (2024-10-04)" (ul (li "Support for CHICKEN 6") (li "Generate reproducible tarballs (requires GNU tar, specifically)") (li (tt "VERSION") " files are no longer generated (due to " (link "https://bugs.call-cc.org/ticket/1753" "#1753") ")"))) (section 5 "version 0.10.0 (2021-12-25)" (ul (li "Generate tarballs with a " (tt "VERSION") " file (for " (tt "chicken-install") " to be able to determine egg versions when installing from tarball sources)."))) (section 5 "version 0.9.0" (ul (li "CHICKEN 5 support for egg-tarballs-index") (li "egg-tarballs-index: new command line option to specify the CHICKEN version to assume when generating the egg index: " (tt "-chicken-version")) (li "egg-tarballs-index: mandatory command line parameters are now named (" (tt "-henrietta-cache-dir") " and " (tt "-tarballs-dir")))) (section 5 "version 0.8.1" (ul (li "Fix bug in the generation of egg indexes (bug introduced in 0.8.0)"))) (section 5 "version 0.8.0" (ul (li "Generate .sha1 files in a format that the sha1sum tool can handle"))) (section 5 "version 0.7.2" (ul (li "CHICKEN 5 support"))) (section 5 "version 0.7.1" (ul (li "Fix tests"))) (section 5 "version 0.7.0" (ul (li "egg-tarballs-index: make sure that all dependencies are symbols") (li "egg-tarballs-index: bump index format version to 2"))) (section 5 "version 0.6.0" (ul (li "Add " (tt "egg-tarballs-index")))) (section 5 "version 0.5.0" (ul (li "Compatibility with both old and new henrietta-cache cache formats"))) (section 5 "version 0.4.1" (ul (li "Fix tests so that they work for both " (int-link "/egg/salmonella" "salmonella") " and " (tt "chicken-install -test") " when CHICKEN tools are not in system's " (tt "PATH")))) (section 5 "version 0.4" (ul (li "More test fixes"))) (section 5 "version 0.3" (ul (li "Test fixes"))) (section 5 "version 0.2" (ul (li "Initial release"))))))