? Pending

User tests: Successful: Unsuccessful:

avatar richard67
richard67
18 Dec 2022

Pull Request for Issue # .

Summary of Changes

The build script includes a call parameter disable-patch-packages which is defined here https://github.com/joomla/joomla-cms/blob/4.2-dev/build/build.php#L225 and used here https://github.com/joomla/joomla-cms/blob/4.2-dev/build/build.php#L232 and this is then used here https://github.com/joomla/joomla-cms/blob/4.2-dev/build/build.php#L443 for not building patch packages like e.g. currently 4.2.6 to 4.2.7 and 4.2.x to 4.2.7 because these packages might not be complete in Joomla 4, which is a know issue and for which this parameter is a temporary workaround.

But the help of the build script doesn't tell anything about that parameter.

This PR here fixes that by adding the missing information and properly aligning the output with tabulators to that long parameter name.

Testing Instructions

The test requires a development environment on a git clone with PHP CLI either on Linux or an other Unixoid, or when on Windows it requires WSL.

Run php ./build/build.php --help in a command shell on your Joomla root.

Actual result BEFORE applying this Pull Request

No information about the disable-patch-packages parameter, and the output is not properly aligned with tabs.

Usage: php ./build/build.php [options]
	[options]:
		--remote=<remote>:	The git remote reference to build from (ex: `tags/3.8.6`, `4.0-dev`), defaults to the most recent tag for the repository
		--exclude-zip:		Exclude the generation of .zip packages
		--exclude-gzip:		Exclude the generation of .tar.gz packages
		--exclude-bzip2:	Exclude the generation of .tar.bz2 packages
		--include-zstd:	Include the generation of .tar.zst packages
		--help:			Show this help output

Expected result AFTER applying this Pull Request

Information about the disable-patch-packages parameter, and the output is properly aligned with tabs.

Usage: php ./build/build.php [options]
	[options]:
		--remote=<remote>:		The git remote reference to build from (ex: `tags/3.8.6`, `4.0-dev`), defaults to the most recent tag for the repository
		--exclude-zip:			Exclude the generation of .zip packages
		--exclude-gzip:			Exclude the generation of .tar.gz packages
		--exclude-bzip2:		Exclude the generation of .tar.bz2 packages
		--include-zstd:			Include the generation of .tar.zst packages
		--disable-patch-packages:	Disable the generation of patch packages
		--help:				Show this help output

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

avatar joomla-cms-bot joomla-cms-bot - change - 18 Dec 2022
Category Repository
avatar richard67 richard67 - open - 18 Dec 2022
avatar richard67 richard67 - change - 18 Dec 2022
Status New Pending
avatar brianteeman brianteeman - test_item - 18 Dec 2022 - Tested successfully
avatar brianteeman
brianteeman - comment - 18 Dec 2022

I have tested this item successfully on 10d359f


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/39445.

avatar richard67 richard67 - change - 18 Dec 2022
Title
Add missing help for disable-patch-packages parameter of the build.pphp script
Add missing help for disable-patch-packages parameter of the build.php script
avatar richard67 richard67 - edited - 18 Dec 2022
avatar wilsonge wilsonge - change - 18 Dec 2022
Status Pending Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2022-12-18 14:31:11
Closed_By wilsonge
Labels Added: ?
avatar wilsonge wilsonge - close - 18 Dec 2022
avatar wilsonge wilsonge - merge - 18 Dec 2022
avatar wilsonge
wilsonge - comment - 18 Dec 2022

Thanks!

Add a Comment

Login with GitHub to post a comment