Skip to content

[v8] Remove useless new lines in help#3769

Open
marckhouzam wants to merge 1 commit intocloudfoundry:v8from
marckhouzam:marck/cleanup
Open

[v8] Remove useless new lines in help#3769
marckhouzam wants to merge 1 commit intocloudfoundry:v8from
marckhouzam:marck/cleanup

Conversation

@marckhouzam
Copy link
Copy Markdown
Contributor

Description of the Change

Remove extra new lines from the usage to make the help and generated documentation more readable.

While at it replace a set of spaces with a tab for an import.

Testing done

Before the PR, notice the below 3 usage sections have extra empty lines:

$ ./out/cf delete-orphaned-routes -h
NAME:
   delete-orphaned-routes - Delete all orphaned routes in the currently targeted space (i.e. those that are not mapped to an app or service instance)

USAGE:
   cf delete-orphaned-routes [-f]


OPTIONS:
   -f      Force deletion without confirmation

SEE ALSO:
   delete-route, routes

$ ./out/cf delete-service-broker -h
NAME:
   delete-service-broker - Delete a service broker

USAGE:
   cf delete-service-broker SERVICE_BROKER [-f]



OPTIONS:
   -f      Force deletion without confirmation

SEE ALSO:
   delete-service, purge-service-offering, service-brokers

$ ./out/cf update-buildpack -h
NAME:
   update-buildpack - Update a buildpack

USAGE:
   cf update-buildpack BUILDPACK [-p PATH | -s STACK | --assign-stack NEW_STACK] [-i POSITION] [--rename NEW_NAME] [--enable|--disable] [--lock|--unlock]

TIP:
When using the 'buildpack' lifecycle type, Path should be a zip file, a url to a zip file, or a local directory. When using the 'cnb' lifecycle, Path should be a cnb file or gzipped oci image. Position is a positive integer, sets priority, and is sorted from lowest to highest.

Use '--assign-stack' with caution. Associating a buildpack with a stack that it does not support may result in undefined behavior. Additionally, changing this association once made may require a local copy of the buildpack.



OPTIONS:
   --assign-stack       Assign a stack to a buildpack that does not have a stack association
   --disable            Disable the buildpack from being used for staging
   --enable             Enable the buildpack to be used for staging
   --lock               Lock the buildpack to prevent updates
   --path, -p           Path to directory or zip file
   --position, -i       The order in which the buildpacks are checked during buildpack auto-detection
   --rename             Rename an existing buildpack
   --stack, -s          Specify stack to disambiguate buildpacks with the same name
   --lifecycle, -l      Specify lifecycle to disambiguate buildpacks with the same name
   --unlock             Unlock the buildpack to enable updates

SEE ALSO:
   buildpacks, create-buildpack, delete-buildpack

With the PR, notice the usage no longer has the extra empty lines:

$ ./out/cf delete-orphaned-routes -h
NAME:
   delete-orphaned-routes - Delete all orphaned routes in the currently targeted space (i.e. those that are not mapped to an app or service instance)

USAGE:
   cf delete-orphaned-routes [-f]

OPTIONS:
   -f      Force deletion without confirmation

SEE ALSO:
   delete-route, routes
$ ./out/cf delete-service-broker -h
NAME:
   delete-service-broker - Delete a service broker

USAGE:
   cf delete-service-broker SERVICE_BROKER [-f]

OPTIONS:
   -f      Force deletion without confirmation

SEE ALSO:
   delete-service, purge-service-offering, service-brokers
$ ./out/cf update-buildpack -h
NAME:
   update-buildpack - Update a buildpack

USAGE:
   cf update-buildpack BUILDPACK [-p PATH | -s STACK | --assign-stack NEW_STACK] [-i POSITION] [--rename NEW_NAME] [--enable|--disable] [--lock|--unlock]

TIP:
When using the 'buildpack' lifecycle type, Path should be a zip file, a url to a zip file, or a local directory. When using the 'cnb' lifecycle, Path should be a cnb file or gzipped oci image. Position is a positive integer, sets priority, and is sorted from lowest to highest.

Use '--assign-stack' with caution. Associating a buildpack with a stack that it does not support may result in undefined behavior. Additionally, changing this association once made may require a local copy of the buildpack.

OPTIONS:
   --assign-stack       Assign a stack to a buildpack that does not have a stack association
   --disable            Disable the buildpack from being used for staging
   --enable             Enable the buildpack to be used for staging
   --lock               Lock the buildpack to prevent updates
   --path, -p           Path to directory or zip file
   --position, -i       The order in which the buildpacks are checked during buildpack auto-detection
   --rename             Rename an existing buildpack
   --stack, -s          Specify stack to disambiguate buildpacks with the same name
   --lifecycle, -l      Specify lifecycle to disambiguate buildpacks with the same name
   --unlock             Unlock the buildpack to enable updates

SEE ALSO:
   buildpacks, create-buildpack, delete-buildpack

Signed-off-by: Marc Khouzam <marc.khouzam@broadcom.com>
@marckhouzam marckhouzam changed the title Remove useless new lines Remove useless new lines in help Apr 20, 2026
@anujc25 anujc25 changed the title Remove useless new lines in help [v8] Remove useless new lines in help Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant