[v2] make.sh-usage: Ship changes to make files
Commit Message
In make.sh-usage document:
- updated with descriptions for various commands
- removed descriptions for old commands
In make.sh script:
- updated make.sh usage line "Usage: $0 [OPTIONS] {build|check-manualpages|..."
- removed make.sh clear screen commands in build area and toolchain area
Signed-off-by: Jon Murphy <jon.murphy@ipfire.org>
---
doc/make.sh-usage | 41 ++++++++++++++++++++++-------------------
make.sh | 10 ++--------
2 files changed, 24 insertions(+), 27 deletions(-)
Comments
Thank you.
Ideally this should have been split into two patches, because they are two different changes - logically speaking:
* Removing “clear”
* Updating the help texts
Since this is trivial and it is not worth anyones time to split this patch, this should be merged. I just wanted to say for next time :)
-Michael
Reviewed-by: Michael Tremer <michael.tremer@ipfire.org>
> On 31 May 2022, at 00:50, Jon Murphy <jon.murphy@ipfire.org> wrote:
>
> In make.sh-usage document:
> - updated with descriptions for various commands
> - removed descriptions for old commands
>
> In make.sh script:
> - updated make.sh usage line "Usage: $0 [OPTIONS] {build|check-manualpages|..."
> - removed make.sh clear screen commands in build area and toolchain area
>
> Signed-off-by: Jon Murphy <jon.murphy@ipfire.org>
> ---
> doc/make.sh-usage | 41 ++++++++++++++++++++++-------------------
> make.sh | 10 ++--------
> 2 files changed, 24 insertions(+), 27 deletions(-)
>
> diff --git a/doc/make.sh-usage b/doc/make.sh-usage
> index 5e1e3dd22..323417172 100644
> --- a/doc/make.sh-usage
> +++ b/doc/make.sh-usage
> @@ -1,23 +1,26 @@
> -Standard use commands in the order you may need them.
> - downloadsrc : preload all necessary files in cache before compilation
> - build : compile the distribution
> - clean : erase build and log to recompile everything from scratch
> +make.sh - Build and maintain programs and libraries for IPFire source code
>
> -Optional
> - gettoolchain : optionally load from ipfire.org a precompilated toolchain
> - package. This solve some compilation issues on old or very
> - recent distributions and save 20% of next full building time.
> - If you want to use it, do it before build step
> +Standard commands:
> + downloadsrc Preload all necessary files in cache before compilation
> + gettoolchain Optionally load a precompilated toolchain (20% less build time)
> + build Compile distribution
> + clean Erase build and log directories to recompile all from scratch
>
> -Maintainer / advanced commands
> - toolchain : Create our own toolchain package to save 20% of build time.
> - shell : Enter a shell inside the chroot, used to tune lfs script
> - and / or during kernel upgrade to rebuild a new .config
> +Maintainer and advanced commands:
> + check-manualpages Check the manual pages for broken links
> + docker Build a docker image
> + find-dependencies Confirm needed libraries are included in build
> + lang Check translations for missing or obsolete strings
> + shell Enter a shell inside the chroot. Used to tune lfs script
> + and/or during kernel upgrade to rebuild new .config file
> + toolchain Create toolchain package (if not downloaded via `make gettoolchain`)
> + update-contributors Update list of contributors
> + uploadsrc For core developers only to upload source code
>
> +OPTIONS:
> + --target=[aarch64|armv6l|armv7hl|riscv64|x86_64]
> + Cross-compile for this target architecture. Uses the QEMU
> + emulator if needed to virtualise the desired target
> + architecture. Can be permanently set with
> + TARGET_ARCH= in .config file.
>
> -Options:
> - --target=[aarch64|armv5tel|i586] : Cross-compile for this target architecture.
> - Uses the QEMU emulator if needed to virtualise
> - the desired target architecture.
> - Can be permanently set with TARGET_ARCH= in
> - .config.
> diff --git a/make.sh b/make.sh
> index 3ed9190b9..9f3dcd604 100755
> --- a/make.sh
> +++ b/make.sh
> @@ -1715,7 +1715,7 @@ buildipfire() {
> lfsmake2 pmacct
> lfsmake2 squid-asnbl
> lfsmake2 qemu-ga
> - lfsmake2 gptfdisk
> + lfsmake2 gptfdisk
> }
>
> buildinstaller() {
> @@ -1824,9 +1824,6 @@ case "$1" in
> build)
> START_TIME="${SECONDS}"
>
> - # Clear screen
> - ${INTERACTIVE} && clear
> -
> PACKAGE="$BASEDIR/cache/toolchains/$SNAME-$VERSION-toolchain-$TOOLCHAINVER-${BUILD_ARCH}.tar.zst"
> #only restore on a clean disk
> if [ ! -e "${BASEDIR}/build${TOOLS_DIR}/.toolchain-successful" ]; then
> @@ -1970,9 +1967,6 @@ downloadsrc)
> cd - >/dev/null 2>&1
> ;;
> toolchain)
> - # Clear screen
> - ${INTERACTIVE} && clear
> -
> prepareenv
> print_build_stage "Toolchain compilation (${BUILD_ARCH})"
> buildtoolchain
> @@ -2074,7 +2068,7 @@ check-manualpages)
> fi
> ;;
> *)
> - echo "Usage: $0 [OPTIONS] {build|changelog|clean|gettoolchain|downloadsrc|shell|sync|toolchain|update-contributors|find-dependencies|check-manualpages}"
> + echo "Usage: $0 [OPTIONS] {build|check-manualpages|clean|docker|downloadsrc|find-dependencies|gettoolchain|lang|shell|toolchain|update-contributors|uploadsrc}"
> cat doc/make.sh-usage
> ;;
> esac
> --
> 2.30.2
>
@@ -1,23 +1,26 @@
-Standard use commands in the order you may need them.
- downloadsrc : preload all necessary files in cache before compilation
- build : compile the distribution
- clean : erase build and log to recompile everything from scratch
+make.sh - Build and maintain programs and libraries for IPFire source code
-Optional
- gettoolchain : optionally load from ipfire.org a precompilated toolchain
- package. This solve some compilation issues on old or very
- recent distributions and save 20% of next full building time.
- If you want to use it, do it before build step
+Standard commands:
+ downloadsrc Preload all necessary files in cache before compilation
+ gettoolchain Optionally load a precompilated toolchain (20% less build time)
+ build Compile distribution
+ clean Erase build and log directories to recompile all from scratch
-Maintainer / advanced commands
- toolchain : Create our own toolchain package to save 20% of build time.
- shell : Enter a shell inside the chroot, used to tune lfs script
- and / or during kernel upgrade to rebuild a new .config
+Maintainer and advanced commands:
+ check-manualpages Check the manual pages for broken links
+ docker Build a docker image
+ find-dependencies Confirm needed libraries are included in build
+ lang Check translations for missing or obsolete strings
+ shell Enter a shell inside the chroot. Used to tune lfs script
+ and/or during kernel upgrade to rebuild new .config file
+ toolchain Create toolchain package (if not downloaded via `make gettoolchain`)
+ update-contributors Update list of contributors
+ uploadsrc For core developers only to upload source code
+OPTIONS:
+ --target=[aarch64|armv6l|armv7hl|riscv64|x86_64]
+ Cross-compile for this target architecture. Uses the QEMU
+ emulator if needed to virtualise the desired target
+ architecture. Can be permanently set with
+ TARGET_ARCH= in .config file.
-Options:
- --target=[aarch64|armv5tel|i586] : Cross-compile for this target architecture.
- Uses the QEMU emulator if needed to virtualise
- the desired target architecture.
- Can be permanently set with TARGET_ARCH= in
- .config.
@@ -1715,7 +1715,7 @@ buildipfire() {
lfsmake2 pmacct
lfsmake2 squid-asnbl
lfsmake2 qemu-ga
- lfsmake2 gptfdisk
+ lfsmake2 gptfdisk
}
buildinstaller() {
@@ -1824,9 +1824,6 @@ case "$1" in
build)
START_TIME="${SECONDS}"
- # Clear screen
- ${INTERACTIVE} && clear
-
PACKAGE="$BASEDIR/cache/toolchains/$SNAME-$VERSION-toolchain-$TOOLCHAINVER-${BUILD_ARCH}.tar.zst"
#only restore on a clean disk
if [ ! -e "${BASEDIR}/build${TOOLS_DIR}/.toolchain-successful" ]; then
@@ -1970,9 +1967,6 @@ downloadsrc)
cd - >/dev/null 2>&1
;;
toolchain)
- # Clear screen
- ${INTERACTIVE} && clear
-
prepareenv
print_build_stage "Toolchain compilation (${BUILD_ARCH})"
buildtoolchain
@@ -2074,7 +2068,7 @@ check-manualpages)
fi
;;
*)
- echo "Usage: $0 [OPTIONS] {build|changelog|clean|gettoolchain|downloadsrc|shell|sync|toolchain|update-contributors|find-dependencies|check-manualpages}"
+ echo "Usage: $0 [OPTIONS] {build|check-manualpages|clean|docker|downloadsrc|find-dependencies|gettoolchain|lang|shell|toolchain|update-contributors|uploadsrc}"
cat doc/make.sh-usage
;;
esac