1
0
mirror of https://github.com/jordansissel/fpm synced 2025-04-09 10:59:08 +02:00

Move generated cli docs to packages/cli/{type}.rst

I'm hoping this makes it easier to find files in the docs/packages
directory.
This commit is contained in:
Jordan Sissel 2021-11-04 22:23:41 -07:00 committed by Jordan Sissel
parent aecf23801d
commit e8fb21d725
27 changed files with 26 additions and 26 deletions

@ -23,12 +23,12 @@ cli-reference.rst: ../lib/fpm/package/*.rb ../lib/fpm/package.rb
ruby generate-cli-reference.rb > $@
package-type-cli:
$(MAKE) $(addprefix packages/,$(addsuffix -cli.rst,$(notdir $(basename $(wildcard ../lib/fpm/package/*.rb)))))
$(MAKE) $(addprefix packages/cli/,$(addsuffix .rst,$(notdir $(basename $(wildcard ../lib/fpm/package/*.rb)))))
packages/cli:
mkdir $@
packages/cli/%-cli.rst: ../lib/fpm/package/%.rb packages/cli
packages/cli/%.rst: ../lib/fpm/package/%.rb packages/cli
ruby generate-cli-reference.rb $* > $@

@ -588,6 +588,27 @@ General Options
* ``--snap-grade GRADE``
- (snap only) Grade of this snap.
* ``--pleaserun-name SERVICE_NAME``
- (pleaserun only) The name of the service you are creating
* ``--pleaserun-chdir CHDIR``
- (pleaserun only) The working directory used by the service
* ``--pacman-optional-depends PACKAGE``
- (pacman only) Add an optional dependency to the pacman package.
* ``--[no-]pacman-use-file-permissions``
- (pacman only) Use existing file permissions when defining ownership and modes
* ``--pacman-user USER``
- (pacman only) The owner of files in this package
* ``--pacman-group GROUP``
- (pacman only) The group owner of files in this package
* ``--pacman-compression COMPRESSION``
- (pacman only) The compression type to use, must be one of gz, bzip2, xz, zstd, none.
* ``--virtualenv-pypi PYPI_URL``
- (virtualenv only) PyPi Server uri for retrieving packages.
@ -615,27 +636,6 @@ General Options
* ``--virtualenv-find-links PIP_FIND_LINKS``
- (virtualenv only) If a url or path to an html file, then parse for links to archives. If a local path or file:// url that's a directory, then look for archives in the directory listing.
* ``--pacman-optional-depends PACKAGE``
- (pacman only) Add an optional dependency to the pacman package.
* ``--[no-]pacman-use-file-permissions``
- (pacman only) Use existing file permissions when defining ownership and modes
* ``--pacman-user USER``
- (pacman only) The owner of files in this package
* ``--pacman-group GROUP``
- (pacman only) The group owner of files in this package
* ``--pacman-compression COMPRESSION``
- (pacman only) The compression type to use, must be one of gz, bzip2, xz, zstd, none.
* ``--pleaserun-name SERVICE_NAME``
- (pleaserun only) The name of the service you are creating
* ``--pleaserun-chdir CHDIR``
- (pleaserun only) The working directory used by the service
apk
---

@ -114,4 +114,4 @@ And maybe the architecture is wrong. fpm defaulted to amd64 (what fpm calls
Deb-specific command line flags
-------------------------------
.. include:: deb-cli.rst
.. include:: cli/deb.rst

@ -3,7 +3,7 @@ rpm - RedHat Package Manager
rpm is the package format used on RedHat Enterprise (RHEL), Fedora, CentOS, and
a number of other Linux distributions.
You may be familiar with tools such as `dnf` and `yum` for installing packages from repositories. The package files that these tools install are rpms.
Supported Uses in FPM
@ -78,4 +78,4 @@ And maybe the architecture is wrong. fpm defaulted to x86_64 (what fpm calls
RPM-specific command line flags
-------------------------------
.. include:: rpm-cli.rst
.. include:: cli/rpm.rst