gen_script_man_pages.sh.man.txt #2

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • doc/
  • gen/
  • gen_script_man_pages.sh.man.txt
  • View
  • Commits
  • Open Download .zip Download (3 KB)
USAGE for gen_script_man_pages.sh v1.6.0:

gen_script_man_pages.sh [<Script> [<Script2> ...]] [-rec | -submit] [-L <log>] [-d|-D]
or

gen_script_man_pages.sh [-h|-man|-V]


DESCRIPTION:
	This script generates man pages for SDP shell scripts. This is done by
Generating doc for: helix_binaries/get_helix_binaries.sh
Generating doc for: Server/Unix/p4/common/bin/ccheck.sh
Generating doc for: Server/Unix/p4/common/bin/load_checkpoint.sh
Generating doc for: Server/Unix/p4/common/bin/mkrep.sh
Generating doc for: Server/Unix/p4/common/bin/p4login
Generating doc for: Server/Unix/p4/common/bin/p4pcm.pl
Generating doc for: Server/Unix/p4/common/bin/p4verify.sh
Generating doc for: Server/Unix/p4/common/bin/sdp_health_check.sh
Generating doc for: Server/Unix/p4/common/bin/upgrade.sh
Generating doc for: Server/Unix/p4/common/bin/verify_sdp.sh
Generating doc for: Server/Unix/p4/common/sdp_upgrade/sdp_upgrade.sh
Generating doc for: Server/Unix/setup/gen_sudoers.sh
Generating doc for: Server/Unix/setup/install_sdp.sh
Generating doc for: Server/Unix/setup/mkdirs.sh
Generating doc for: Server/Unix/p4/common/sdp_upgrade/clear_depot_Map_fields.sh
Generating file [sdp_install.cfg] with this command: /opt/perforce/dev/sdp/Server/Unix/setup/install_sdp.sh -C

Interim script docs generated successfully.

No reconcile or submit attempted. Consider running with '-rec' and/or '-submit' options.
cs for.  If no
	script is specified, man pages are generated for all configured scripts.

	Only the script basename, e.g. mkrep.sh or load_checkpoint.sh, should be
	given. This script knows where all documented scripts exist in the SDP
	structure, so the user need only specify the basename.

 -rec
	Specify '-rec' to reconcile of generated files.

 -s[ubmit]
	Specify '-s' (or '-submit') to submit any generated doc files with a
	changelist description of: 'Updated generate script man pages.'

	The '-submit' is ignored if associated script are checked out.

	The '-submit' option implies '-rec'.

	Files may submitted to:

	//guest/perforce_software/sdp/dev/doc/gen/...

 -L <log>
	Specify the path to a log file, or the special value 'off' to disable
	logging.  By default, all output (stdout and stderr) goes to
	/tmp/gen_script_man_page.<datestamp>.log

	NOTE: This script is self-logging.  That is, output displayed on the screen
	is simultaneously captured in the log file.  Do not run this script with
	redirection operators like '> log' or '2>&1', and do not use 'tee.'

 -d     Debug mode, generates more verbose output.

 -D     Set extreme debugging verbosity using bash 'set -x' mode. Implies '-d'.

HELP OPTIONS:
 -h	Display short help message
 -man	Display man-style help message
 -V	Dispay version info for this script and its libraries.

# Change User Description Committed
#4 31067 C. Thomas Tyler Updated generated script man pages.
#3 30912 C. Thomas Tyler Updated generated script man pages.
#2 30782 C. Thomas Tyler Added new install_sdp.sh script and supporting documentation.

The new install_sdp.sh makes SDP independent of the separate
Helix Installer software (the reset_sdp.sh script).  The new
script greatly improves the installation experience for new
server machines. It is ground up rewrite of the reset_sdp.sh
script. The new script preserves the desired behaviors of the
original Helix Installer script, but is focused on the use
case of a fresh install on a new server machine. With this focus,
the scripts does not have any "reset" logic, making it completely
safe.

Added various files and functionalityfrom Helix Installer into SDP.
* Added firewalld templates to SDP, and added ufw support.
* Improved sudoers generation.
* Added bash shell templates.

This script also installs in the coming SDP Package structure.
New installs use a modified SDP structure that makes it so the
/p4/sdp and /p4/common now point to folders on the local OS
volume rather than the /hxepots volume. The /hxdepots volume,
which is often NFS mounted, is still used for depots and
checkpoints, and for backups.

The new structure uses a new /opt/perforce/helix-sdp structure
under which /p4/sdp and /p4/common point. This structure also
contains the expaneded SDP tarball, downloads, helix_binaries,
etc.

This change represents the first of 3-phase rollout of the new
package structure. In this first phase, the "silent beta" phase,
the new structure is used for new installations only. This phase
requires no changes to released SDP scripts except for mkdirs.sh,
and even that script remains backward-compatible with the old
structure if used independently of install_sdp.sh.  If used with
install_sdp.sh, the new structure is used.

In the second phase (targeted for SPD 2024.2 release), the
sdp_upgrade.sh script will convert existing installations to
the new structure.

In the third phase (targeted for SDP 2025.x), this script will
be incorporated into OS pacakge installations for the helix-sdp
package.

Perforce internal wikis have more detail on this change.

#review-30783
#1 30115 C. Thomas Tyler Updated generated script man pages.