add how to use mkstages scripts.

2 files changed, 117 insertions, 0 deletions

diff --git a/scripts/mkstages/doc/how_to_use_create_forcestage3.txt b/scripts/mkstages/doc/how_to_use_create_forcestage3.txt
new file mode 100644
index 0000000..6d1e90a
--- /dev/null
+++ b/scripts/mkstages/doc/how_to_use_create_forcestage3.txt
@@ -0,0 +1,66 @@
+How to use create_forcestage3.sh
+
+This script will create a source file for dev-utils/catalyst.
+If you want to create new stages, this script will help you.
+
+Usage:
+Please don't forget to create a log file! It's very useful.
+
+amd64-fbsd)
+SET_MAKEOPTS=3 \
+TARGETVER=11.1 \
+TARGETARCH=amd64 \
+OLDSTAGE3="http://distfiles.gentoo.org/experimental/bsd/freebsd/stages/amd64-fbsd-9.1/stage3-amd64-freebsd-9.1.tar.bz2" \
+bash /tmp/create_forcestage3.sh 2>&1 | tee ~/create_source_amd64_11.1.log
+
+amd64-fbsd/clang)
+SET_MAKEOPTS=3 \
+TARGETVER=11.1 \
+TARGETARCH=amd64 \
+OLDSTAGE3="http://distfiles.gentoo.org/experimental/bsd/freebsd/stages/amd64-fbsd-9.1/clang/stage3-amd64-clangfbsd-9.1.tar.bz2" \
+CLANG=1 \
+bash /tmp/create_forcestage3.sh 2>&1 | tee ~/create_source_amd64_clang_11.1.log
+
+x86-fbsd)
+SET_MAKEOPTS=3 \
+TARGETVER=11.1 \
+TARGETARCH=x86 \
+OLDSTAGE3="http://dev.gentoo.org/~aballier/fbsd9.0/x86/stage3-i686-freebsd-9.0.tar.bz2" \
+bash /tmp/create_forcestage3.sh 2>&1 | tee ~/create_source_x86_11.1.log
+
+
+Require environment variables:
+You need to set some environment variables:
+
+TARGETVER
+Set the target version. e.g.) 11.1
+
+TARGETARCH
+Set the target architecture. You can set amd64 or x86.
+
+OLDSTAGE3
+Set the old version of stage3 file. You can set local file name or URL.
+
+Tested stages list:
+amd64-fbsd)
+http://distfiles.gentoo.org/experimental/bsd/freebsd/stages/amd64-fbsd-9.1/stage3-amd64-freebsd-9.1.tar.bz2
+amd64-fbsd/clang)
+http://distfiles.gentoo.org/experimental/bsd/freebsd/stages/amd64-fbsd-9.1/clang/stage3-amd64-clangfbsd-9.1.tar.bz2
+x86-fbsd) This URL is 404...
+http://dev.gentoo.org/~aballier/fbsd9.0/x86/stage3-i686-freebsd-9.0.tar.bz2
+
+
+Optional environment variables:
+Also, you can set some additional environment variables:
+
+SET_MAKEOPTS
+If you set 1 or more, your input number will be set.
+
+CLANG
+If you want to create clang stages, please set 1.
+
+PORTDIR
+If you aren't using /usr/portage, please set it.
+
+TMPFS
+If you set 1, the tmpfs will be used for /var/tmp/portage.
diff --git a/scripts/mkstages/doc/how_to_use_stages_builder.txt b/scripts/mkstages/doc/how_to_use_stages_builder.txt
new file mode 100644
index 0000000..2836b13
--- /dev/null
+++ b/scripts/mkstages/doc/how_to_use_stages_builder.txt
@@ -0,0 +1,51 @@
+How to use stages_builder.sh
+
+This script will create stage files with dev-utils/catalyst.
+If you want to create new stages, this script will help you.
+
+Usage:
+Please don't forget to create a log file! It's very useful.
+
+amd64-fbsd)
+WORKDATE=20171201 \
+TARGETVER=11.1 \
+SOURCE_STAGE=stage3-amd64-fbsd-11.1-forcestage3 \
+bash /tmp/stages_builder.sh 2>&1 | tee ~/create_stages_amd64_11.1.log
+
+amd64-fbsd/clang)
+WORKDATE=20171201 \
+TARGETVER=11.1 \
+SOURCE_STAGE=stage3-amd64-fbsd-11.1-forcestage3-cl \
+CLANG=1 \
+bash /tmp/stages_builder.sh 2>&1 | tee ~/create_stages_amd64_clang_11.1.log
+
+x86-fbsd)
+TARGETARCH=x86 \
+WORKDATE=20171201 \
+TARGETVER=11.1 \
+SOURCE_STAGE=stage3-x86-fbsd-11.1-forcestage3 \
+bash /tmp/stages_builder.sh 2>&1 | tee ~/create_stages_x86_11.1.log
+
+
+Require environment variables:
+You need to set some environment variables:
+
+WORKDATE
+Set the date of the portage snapshot.
+If it doesn't exist, it will be created using your /usr/portage.
+
+TARGETVER
+Set the target version. e.g.) 11.1
+
+SOURCE_STAGE
+Set a source file.
+
+
+Optional environment variables:
+Also, you can set some additional environment variables:
+
+CLANG
+If you want to create clang stages, please set 1.
+
+TARGETARCH
+If you want to create x86 stages on amd64-fbsd, please set x86.