Change docs tooling to use podman instead of docker

New feature here is that --foo and --[no-]foo are both sorted as "foo",
so flags should be reasonably grouped together now.

CHANGELOG.rst

@@ -1,6 +1,29 @@
 Release Notes and Change Log
 ============================
 
+1.15.0 (unreleased)
+^^^^^^^^^^^^^^^^^^^
+* New flag ``--fpm-options-file path/to/file`` which allows you to specify additional fpm flags in an external file of your choosing. (`#1905`_, `#1902`_, `#1827`_; Jordan Sissel, Will Furnell, hjpotter92)
+* deb: Periods are now accepted in package names (`#1899`_; C. Cooke)
+* Fix bug where fpm would crash if ``--workdir`` pointed at a path that didn't
+  exist. (`#1959`_; Jordan Sissel)
+* osxpkg: this package format now supports the fpm ``--prefix`` flag(`#1909`_, `#1908`_; Jordan Sissel, mcataga)
+* cpan: Fix bug where fpm would fail on certain Perl modules due to their source tarball structure (`#1940`_; Nicholas Hubbard, William N. Braswell, Jr.)
+* cpan: Fix crash on certain CPAN modules where the author field was blank (`#1942`_, `#1937`_, `#1523`_, `#1528`_; Nicholas Hubbard, William N. Braswell, Jr.)
+* deb: The distribution field of the debian changelog and changes files will now use the value set by ``--deb-dist`` (default is "unstable") (`#1934`_; Chabert Loïc)
+* python: Fix errors in how fpm invoked ``pip``. Previously, fpm would use pip's ``--build`` flag, but this was removed a while ago, and fpm is now aware! (`#1896`_, `#1831`_, `#1893`_, `#1916`_; Jordan Sissel, Svyatogor Chuykov)
+* pleaserun: Add ``--pleaserun-user`` flag. (`#1912`_; Evgeny Stambulchik)
+* deb: The default ``--deb-priority`` is now "optional" instead of "extra" (`#1913`_; Chris Novakovic)
+* https://github.com/jordansissel/fpm/pull/1897 (`#1897`_; Jordan Sissel)
+* Enable installation of fpm on older versions of ruby. This change removed ``git`` rubygem dependency. (`#1946`_, `#1923`_; Jordan Sissel, Andreas Wirooks, Ruslan Kuprieiev, jamshid, Lorenzo Castellino, Sam Hughes)
+* Enable operation of fpm on very old versions of ruby (as old as Ruby 1.9.3). This changed removed ``json`` rubygem dependency. (`#1950`_, `#1949`_, `#1741`_, `#1264`_, `#1798`_, `#1800`_, `#1784`_; Jordan Sissel and many others)
+* Fix bug where subprocesses could hang waiting for input (`#1955`_, `#1519`_, `#1522`_; Nicholas Hubbard, William N. Braswell, Jr.)
+* Update Dockerfile to use ubuntu:20.04 (`#1935`_; Gnought)
+* internal: Fix a code typo (`#1948`_; Nicholas Hubbard)
+* internal tests: Support newer versions of lintian (`#1939`_, `#1907`_; Jordan Sissel)
+* Improve support for Ruby 3.1.0 and newer that would previously crash with an error mentioning Psych::DisallowedClass (`#1898`_, `#1895`_; Jordan Sissel, Alexandre ZANNI)
+* Improve support for Ruby 3.1.0 and newer that changed the API for ERB
+
 1.14.2 (March 30, 2022)
 ^^^^^^^^^^^^^^^^^^^^^^^
 * deb: fix bug causing ``--deb-compression none`` to invoke ``tar`` incorrectly (`#1879`_; John Howard)

docs/Makefile

@@ -20,7 +20,7 @@ changelog_links.rst: ../CHANGELOG.rst Makefile
 # CLI reference is generated based on the the command line flags
 cli-reference.rst: generate-cli-reference.rb Makefile
 cli-reference.rst: ../lib/fpm/package/*.rb ../lib/fpm/package.rb
-	ruby generate-cli-reference.rb > $@
+	ruby -I ../lib generate-cli-reference.rb > $@
 
 package-type-cli: 
 	$(MAKE) $(addprefix packages/cli/,$(addsuffix .rst,$(notdir $(basename $(wildcard ../lib/fpm/package/*.rb)))))
@@ -28,20 +28,20 @@ package-type-cli:
 packages/cli:
 	mkdir $@
 
-packages/cli/%.rst: ../lib/fpm/package/%.rb packages/cli
-	ruby generate-cli-reference.rb $* > $@
+packages/cli/%.rst: ../lib/fpm/package/%.rb packages/cli generate-cli-reference.rb Makefile
+	ruby -I ../lib generate-cli-reference.rb $* > $@
 
 
-.PHONY: docker-prep
-docker-prep: Dockerfile
-	@docker images fpm-sphinx | grep -q '^fpm-sphinx ' \
-	|| docker build -t $(IMAGE) .
+.PHONY: podman-prep
+podman-prep: Dockerfile
+	@podman images fpm-sphinx | grep -q '^fpm-sphinx ' \
+	|| podman build -t $(IMAGE) .
 
 .PHONY: build
-build: $(GENERATED_FILES) | docker-prep
-	docker run -it -v $$PWD/../:/project:z $(IMAGE) sh -xc 'make -C /project/docs html && chown -R 1000:1000 /project/docs'
+build: $(GENERATED_FILES) | podman-prep
+	podman run -it -v $$PWD/../:/project:z $(IMAGE) sh -xc 'make -C /project/docs html && chown -R 1000:1000 /project/docs'
 
 
 .PHONY: build
-view: $(GENERATED_FILES) | docker-prep
-	docker run -p 127.0.0.1:8000:8000 -it -v $$PWD/../:/project:z $(IMAGE) sh -xc 'make -C /project/docs livehtml'
+view: $(GENERATED_FILES) | podman-prep
+	podman run -p 127.0.0.1:8000:8000 -it -v $$PWD/../:/project:z $(IMAGE) sh -xc 'make -C /project/docs livehtml'

docs/changelog_links.rst

@@ -37,6 +37,7 @@
 .. _#1253: https://github.com/jordansissel/fpm/issues/1253
 .. _#1259: https://github.com/jordansissel/fpm/issues/1259
 .. _#1262: https://github.com/jordansissel/fpm/issues/1262
+.. _#1264: https://github.com/jordansissel/fpm/issues/1264
 .. _#1266: https://github.com/jordansissel/fpm/issues/1266
 .. _#1287: https://github.com/jordansissel/fpm/issues/1287
 .. _#1291: https://github.com/jordansissel/fpm/issues/1291
@@ -90,6 +91,10 @@
 .. _#1511: https://github.com/jordansissel/fpm/issues/1511
 .. _#1514: https://github.com/jordansissel/fpm/issues/1514
 .. _#1515: https://github.com/jordansissel/fpm/issues/1515
+.. _#1519: https://github.com/jordansissel/fpm/issues/1519
+.. _#1522: https://github.com/jordansissel/fpm/issues/1522
+.. _#1523: https://github.com/jordansissel/fpm/issues/1523
+.. _#1528: https://github.com/jordansissel/fpm/issues/1528
 .. _#1592: https://github.com/jordansissel/fpm/issues/1592
 .. _#1636: https://github.com/jordansissel/fpm/issues/1636
 .. _#1642: https://github.com/jordansissel/fpm/issues/1642
@@ -109,6 +114,7 @@
 .. _#1738: https://github.com/jordansissel/fpm/issues/1738
 .. _#1739: https://github.com/jordansissel/fpm/issues/1739
 .. _#1740: https://github.com/jordansissel/fpm/issues/1740
+.. _#1741: https://github.com/jordansissel/fpm/issues/1741
 .. _#1745: https://github.com/jordansissel/fpm/issues/1745
 .. _#1748: https://github.com/jordansissel/fpm/issues/1748
 .. _#1749: https://github.com/jordansissel/fpm/issues/1749
@@ -122,11 +128,14 @@
 .. _#1772: https://github.com/jordansissel/fpm/issues/1772
 .. _#1774: https://github.com/jordansissel/fpm/issues/1774
 .. _#1775: https://github.com/jordansissel/fpm/issues/1775
+.. _#1784: https://github.com/jordansissel/fpm/issues/1784
 .. _#1785: https://github.com/jordansissel/fpm/issues/1785
 .. _#1786: https://github.com/jordansissel/fpm/issues/1786
 .. _#1788: https://github.com/jordansissel/fpm/issues/1788
 .. _#1794: https://github.com/jordansissel/fpm/issues/1794
 .. _#1797: https://github.com/jordansissel/fpm/issues/1797
+.. _#1798: https://github.com/jordansissel/fpm/issues/1798
+.. _#1800: https://github.com/jordansissel/fpm/issues/1800
 .. _#1803: https://github.com/jordansissel/fpm/issues/1803
 .. _#1811: https://github.com/jordansissel/fpm/issues/1811
 .. _#1812: https://github.com/jordansissel/fpm/issues/1812
@@ -137,7 +146,9 @@
 .. _#1820: https://github.com/jordansissel/fpm/issues/1820
 .. _#1821: https://github.com/jordansissel/fpm/issues/1821
 .. _#1825: https://github.com/jordansissel/fpm/issues/1825
+.. _#1827: https://github.com/jordansissel/fpm/issues/1827
 .. _#1829: https://github.com/jordansissel/fpm/issues/1829
+.. _#1831: https://github.com/jordansissel/fpm/issues/1831
 .. _#1832: https://github.com/jordansissel/fpm/issues/1832
 .. _#1833: https://github.com/jordansissel/fpm/issues/1833
 .. _#1834: https://github.com/jordansissel/fpm/issues/1834
@@ -162,10 +173,37 @@
 .. _#1882: https://github.com/jordansissel/fpm/issues/1882
 .. _#1884: https://github.com/jordansissel/fpm/issues/1884
 .. _#1886: https://github.com/jordansissel/fpm/issues/1886
+.. _#1893: https://github.com/jordansissel/fpm/issues/1893
+.. _#1895: https://github.com/jordansissel/fpm/issues/1895
+.. _#1896: https://github.com/jordansissel/fpm/issues/1896
+.. _#1897: https://github.com/jordansissel/fpm/issues/1897
+.. _#1898: https://github.com/jordansissel/fpm/issues/1898
+.. _#1899: https://github.com/jordansissel/fpm/issues/1899
+.. _#1902: https://github.com/jordansissel/fpm/issues/1902
+.. _#1905: https://github.com/jordansissel/fpm/issues/1905
+.. _#1907: https://github.com/jordansissel/fpm/issues/1907
+.. _#1908: https://github.com/jordansissel/fpm/issues/1908
+.. _#1909: https://github.com/jordansissel/fpm/issues/1909
 .. _#190: https://github.com/jordansissel/fpm/issues/190
+.. _#1912: https://github.com/jordansissel/fpm/issues/1912
+.. _#1913: https://github.com/jordansissel/fpm/issues/1913
+.. _#1916: https://github.com/jordansissel/fpm/issues/1916
 .. _#191: https://github.com/jordansissel/fpm/issues/191
+.. _#1923: https://github.com/jordansissel/fpm/issues/1923
+.. _#1934: https://github.com/jordansissel/fpm/issues/1934
+.. _#1935: https://github.com/jordansissel/fpm/issues/1935
+.. _#1937: https://github.com/jordansissel/fpm/issues/1937
+.. _#1939: https://github.com/jordansissel/fpm/issues/1939
 .. _#193: https://github.com/jordansissel/fpm/issues/193
+.. _#1940: https://github.com/jordansissel/fpm/issues/1940
+.. _#1942: https://github.com/jordansissel/fpm/issues/1942
+.. _#1946: https://github.com/jordansissel/fpm/issues/1946
+.. _#1948: https://github.com/jordansissel/fpm/issues/1948
+.. _#1949: https://github.com/jordansissel/fpm/issues/1949
 .. _#194: https://github.com/jordansissel/fpm/issues/194
+.. _#1950: https://github.com/jordansissel/fpm/issues/1950
+.. _#1955: https://github.com/jordansissel/fpm/issues/1955
+.. _#1959: https://github.com/jordansissel/fpm/issues/1959
 .. _#196: https://github.com/jordansissel/fpm/issues/196
 .. _#198: https://github.com/jordansissel/fpm/issues/198
 .. _#202: https://github.com/jordansissel/fpm/issues/202

docs/generate-cli-reference.rb

@@ -2,6 +2,8 @@
 
 require_relative "../lib/fpm/command"
 
+flagsort = lambda { |x| x.sub(/^--(?:\[no-\])?/, "") }
+
 if ARGV.length == 0
   puts "Command-line Reference"
   puts "=========================="
@@ -13,7 +15,7 @@ if ARGV.length == 0
   puts "General Options"
   puts "---------------"
 
-  FPM::Command.instance_variable_get(:@declared_options).each do |option|
+  FPM::Command.instance_variable_get(:@declared_options).sort_by { |o| flagsort.call(o.switches.first) }.each do |option|
       text = option.description.gsub("\n", " ")
 
       if option.type == :flag
@@ -49,7 +51,7 @@ FPM::Package.types.sort_by { |k,v| k }.each do |name, type|
         puts "This package type has no additional options"
     end
 
-    options.sort_by { |flag, _| flag }.each do |flag, param, help, options, block|
+    options.sort_by { |flag, _| flagsort.call(flag.first) }.each do |flag, param, help, options, block|
         if param == :flag 
             puts "* ``#{flag.first}``"
         else

docs/packages/cli/cpan.rst

@@ -1,21 +1,21 @@
-* ``--[no-]cpan-cpanm-force``
-    - Pass the --force parameter to cpanm
-* ``--[no-]cpan-mirror-only``
-    - Only use the specified mirror for metadata.
-* ``--[no-]cpan-sandbox-non-core``
-    - Sandbox all non-core modules, even if they're already installed
-* ``--[no-]cpan-test``
-    - Run the tests before packaging?
-* ``--[no-]cpan-verbose``
-    - Produce verbose output from cpanm?
 * ``--cpan-cpanm-bin CPANM_EXECUTABLE``
     - The path to the cpanm executable you wish to run.
+* ``--[no-]cpan-cpanm-force``
+    - Pass the --force parameter to cpanm
 * ``--cpan-mirror CPAN_MIRROR``
     - The CPAN mirror to use instead of the default.
+* ``--[no-]cpan-mirror-only``
+    - Only use the specified mirror for metadata.
 * ``--cpan-package-name-prefix NAME_PREFIX``
     - Name to prefix the package name with.
 * ``--cpan-perl-bin PERL_EXECUTABLE``
     - The path to the perl executable you wish to run.
 * ``--cpan-perl-lib-path PERL_LIB_PATH``
     - Path of target Perl Libraries
+* ``--[no-]cpan-sandbox-non-core``
+    - Sandbox all non-core modules, even if they're already installed
+* ``--[no-]cpan-test``
+    - Run the tests before packaging?
+* ``--[no-]cpan-verbose``
+    - Produce verbose output from cpanm?
 

docs/packages/cli/deb.rst

@@ -1,27 +1,11 @@
-* ``--[no-]deb-auto-config-files``
-    - Init script and default configuration files will be labeled as configuration files for Debian packages.
-* ``--[no-]deb-generate-changes``
-    - Generate PACKAGENAME.changes file.
-* ``--[no-]deb-ignore-iteration-in-dependencies``
-    - For '=' (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted
-* ``--[no-]deb-maintainerscripts-force-errorchecks``
-    - Activate errexit shell option according to lintian. https://lintian.debian.org/tags/maintainer-script-ignores-errors.html
-* ``--[no-]deb-no-default-config-files``
-    - Do not add all files in /etc as configuration files by default for Debian packages.
-* ``--[no-]deb-systemd-auto-start``
-    - Start service after install or upgrade
-* ``--[no-]deb-systemd-enable``
-    - Enable service on install or upgrade
-* ``--[no-]deb-systemd-restart-after-upgrade``
-    - Restart service after upgrade
-* ``--[no-]deb-use-file-permissions``
-    - Use existing file permissions when defining ownership and modes
 * ``--deb-activate EVENT``
     - Package activates EVENT trigger
 * ``--deb-activate-noawait EVENT``
     - Package activates EVENT trigger
 * ``--deb-after-purge FILE``
     - A script to be run after package removal to purge remaining (config) files (a.k.a. postrm purge within apt-get purge)
+* ``--[no-]deb-auto-config-files``
+    - Init script and default configuration files will be labeled as configuration files for Debian packages.
 * ``--deb-build-depends DEPENDENCY``
     - Add DEPENDENCY as a Build-Depends
 * ``--deb-changelog FILEPATH``
@@ -38,8 +22,12 @@
     - Set the deb distribution.
 * ``--deb-field 'FIELD: VALUE'``
     - Add custom field to the control file
+* ``--[no-]deb-generate-changes``
+    - Generate PACKAGENAME.changes file.
 * ``--deb-group GROUP``
     - The group owner of files in this package
+* ``--[no-]deb-ignore-iteration-in-dependencies``
+    - For '=' (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted
 * ``--deb-init FILEPATH``
     - Add FILEPATH as an init script
 * ``--deb-installed-size KILOBYTES``
@@ -48,8 +36,12 @@
     - Package is interested in EVENT trigger
 * ``--deb-interest-noawait EVENT``
     - Package is interested in EVENT trigger without awaiting
+* ``--[no-]deb-maintainerscripts-force-errorchecks``
+    - Activate errexit shell option according to lintian. https://lintian.debian.org/tags/maintainer-script-ignores-errors.html
 * ``--deb-meta-file FILEPATH``
     - Add FILEPATH to DEBIAN directory
+* ``--[no-]deb-no-default-config-files``
+    - Do not add all files in /etc as configuration files by default for Debian packages.
 * ``--deb-pre-depends DEPENDENCY``
     - Add DEPENDENCY as a Pre-Depends
 * ``--deb-priority PRIORITY``
@@ -62,12 +54,20 @@
     - Add PACKAGE to Suggests
 * ``--deb-systemd FILEPATH``
     - Add FILEPATH as a systemd script
+* ``--[no-]deb-systemd-auto-start``
+    - Start service after install or upgrade
+* ``--[no-]deb-systemd-enable``
+    - Enable service on install or upgrade
+* ``--[no-]deb-systemd-restart-after-upgrade``
+    - Restart service after upgrade
 * ``--deb-templates FILEPATH``
     - Add FILEPATH as debconf templates file.
 * ``--deb-upstart FILEPATH``
     - Add FILEPATH as an upstart script
 * ``--deb-upstream-changelog FILEPATH``
     - Add FILEPATH as upstream changelog
+* ``--[no-]deb-use-file-permissions``
+    - Use existing file permissions when defining ownership and modes
 * ``--deb-user USER``
     - The owner of files in this package
 

docs/packages/cli/gem.rst

@@ -1,3 +1,7 @@
+* ``--gem-bin-path DIRECTORY``
+    - The directory to install gem executables
+* ``--gem-disable-dependency gem_name``
+    - The gem name to remove from dependency list
 * ``--[no-]gem-embed-dependencies``
     - Should the gem dependencies be installed?
 * ``--[no-]gem-env-shebang``
@@ -6,14 +10,6 @@
     - Should the package dependencies be prefixed?
 * ``--[no-]gem-fix-name``
     - Should the target package name be prefixed?
-* ``--[no-]gem-prerelease``
-    - Allow prerelease versions of a gem
-* ``--[no-]gem-version-bins``
-    - Append the version to the bins
-* ``--gem-bin-path DIRECTORY``
-    - The directory to install gem executables
-* ``--gem-disable-dependency gem_name``
-    - The gem name to remove from dependency list
 * ``--gem-gem PATH_TO_GEM``
     - The path to the 'gem' tool (defaults to 'gem' and searches your $PATH)
 * ``--gem-git-branch GIT_BRANCH``
@@ -24,8 +20,12 @@
     - Name to prefix the package name with.
 * ``--gem-package-prefix NAMEPREFIX``
     - (DEPRECATED, use --package-name-prefix) Name to prefix the package name with.
+* ``--[no-]gem-prerelease``
+    - Allow prerelease versions of a gem
 * ``--gem-shebang SHEBANG``
     - Replace the shebang in the executables in the bin path with a custom string
 * ``--gem-stagingdir STAGINGDIR``
     - The directory where fpm installs the gem temporarily before conversion. Normally a random subdirectory of workdir.
+* ``--[no-]gem-version-bins``
+    - Append the version to the bins
 

docs/packages/cli/osxpkg.rst

@@ -1,11 +1,11 @@
-* ``--[no-]osxpkg-payload-free``
-    - Define no payload, assumes use of script options.
 * ``--osxpkg-dont-obsolete DONT_OBSOLETE_PATH``
     - A file path for which to 'dont-obsolete' in the built PackageInfo. Can be specified multiple times.
 * ``--osxpkg-identifier-prefix IDENTIFIER_PREFIX``
     - Reverse domain prefix prepended to package identifier, ie. 'org.great.my'. If this is omitted, the identifer will be the package name.
 * ``--osxpkg-ownership OWNERSHIP``
     - --ownership option passed to pkgbuild. Defaults to 'recommended'. See pkgbuild(1).
+* ``--[no-]osxpkg-payload-free``
+    - Define no payload, assumes use of script options.
 * ``--osxpkg-postinstall-action POSTINSTALL_ACTION``
     - Post-install action provided in package metadata. Optionally one of 'logout', 'restart', 'shutdown'.
 

docs/packages/cli/p5p.rst

@@ -1,13 +1,13 @@
-* ``--[no-]p5p-lint``
-    - Check manifest with pkglint
-* ``--[no-]p5p-validate``
-    - Validate with pkg install
 * ``--p5p-group GROUP``
     - Set the group to GROUP in the prototype file.
+* ``--[no-]p5p-lint``
+    - Check manifest with pkglint
 * ``--p5p-publisher PUBLISHER``
     - Set the publisher name for the repository
 * ``--p5p-user USER``
     - Set the user to USER in the prototype files.
+* ``--[no-]p5p-validate``
+    - Validate with pkg install
 * ``--p5p-zonetype ZONETYPE``
     - Set the allowed zone types (global, nonglobal, both)
 

docs/packages/cli/pacman.rst

@@ -1,11 +1,11 @@
-* ``--[no-]pacman-use-file-permissions``
-    - Use existing file permissions when defining ownership and modes
 * ``--pacman-compression COMPRESSION``
     - The compression type to use, must be one of gz, bzip2, xz, zstd, none.
 * ``--pacman-group GROUP``
     - The group owner of files in this package
 * ``--pacman-optional-depends PACKAGE``
     - Add an optional dependency to the pacman package.
+* ``--[no-]pacman-use-file-permissions``
+    - Use existing file permissions when defining ownership and modes
 * ``--pacman-user USER``
     - The owner of files in this package
 

docs/packages/cli/pear.rst

@@ -1,9 +1,9 @@
-* ``--[no-]pear-channel-update``
-    - call 'pear channel-update' prior to installation
 * ``--pear-bin-dir BIN_DIR``
     - Directory to put binaries in
 * ``--pear-channel CHANNEL_URL``
     - The pear channel url to use instead of the default.
+* ``--[no-]pear-channel-update``
+    - call 'pear channel-update' prior to installation
 * ``--pear-data-dir DATA_DIR``
     - Specify php dir relative to prefix if differs from pear default (pear/data)
 * ``--pear-package-name-prefix PREFIX``

docs/packages/cli/pleaserun.rst

@@ -2,4 +2,6 @@
     - The working directory used by the service
 * ``--pleaserun-name SERVICE_NAME``
     - The name of the service you are creating
+* ``--pleaserun-user USER``
+    - The user to use for executing this program.
 

docs/packages/cli/python.rst

@@ -1,29 +1,29 @@
+* ``--python-bin PYTHON_EXECUTABLE``
+    - The path to the python executable you wish to run.
 * ``--[no-]python-dependencies``
     - Include requirements defined in setup.py as dependencies.
+* ``--python-disable-dependency python_package_name``
+    - The python package name to remove from dependency list
 * ``--[no-]python-downcase-dependencies``
     - Should the package dependencies be in lowercase?
 * ``--[no-]python-downcase-name``
     - Should the target package name be in lowercase?
+* ``--python-easyinstall EASYINSTALL_EXECUTABLE``
+    - The path to the easy_install executable tool
 * ``--[no-]python-fix-dependencies``
     - Should the package dependencies be prefixed?
 * ``--[no-]python-fix-name``
     - Should the target package name be prefixed?
-* ``--[no-]python-internal-pip``
-    - Use the pip module within python to install modules - aka 'python -m pip'. This is the recommended usage since Python 3.4 (2014) instead of invoking the 'pip' script
-* ``--[no-]python-obey-requirements-txt``
-    - Use a requirements.txt file in the top-level directory of the python package for dependency detection.
-* ``--python-bin PYTHON_EXECUTABLE``
-    - The path to the python executable you wish to run.
-* ``--python-disable-dependency python_package_name``
-    - The python package name to remove from dependency list
-* ``--python-easyinstall EASYINSTALL_EXECUTABLE``
-    - The path to the easy_install executable tool
 * ``--python-install-bin BIN_PATH``
     - The path to where python scripts should be installed to.
 * ``--python-install-data DATA_PATH``
     - The path to where data should be installed to. This is equivalent to 'python setup.py --install-data DATA_PATH
 * ``--python-install-lib LIB_PATH``
     - The path to where python libs should be installed to (default depends on your python installation). Want to find out what your target platform is using? Run this: python -c 'from distutils.sysconfig import get_python_lib; print get_python_lib()'
+* ``--[no-]python-internal-pip``
+    - Use the pip module within python to install modules - aka 'python -m pip'. This is the recommended usage since Python 3.4 (2014) instead of invoking the 'pip' script
+* ``--[no-]python-obey-requirements-txt``
+    - Use a requirements.txt file in the top-level directory of the python package for dependency detection.
 * ``--python-package-name-prefix PREFIX``
     - Name to prefix the package name with.
 * ``--python-package-prefix NAMEPREFIX``

docs/packages/cli/rpm.rst

@@ -1,25 +1,15 @@
+* ``--rpm-attr ATTRFILE``
+    - Set the attribute for a file (%attr), e.g. --rpm-attr 750,user1,group1:/some/file
 * ``--[no-]rpm-auto-add-directories``
     - Auto add directories not part of filesystem
+* ``--rpm-auto-add-exclude-directories DIRECTORIES``
+    - Additional directories ignored by '--rpm-auto-add-directories' flag
 * ``--[no-]rpm-autoprov``
     - Enable RPM's AutoProv option
 * ``--[no-]rpm-autoreq``
     - Enable RPM's AutoReq option
 * ``--[no-]rpm-autoreqprov``
     - Enable RPM's AutoReqProv option
-* ``--[no-]rpm-ignore-iteration-in-dependencies``
-    - For '=' (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted
-* ``--[no-]rpm-macro-expansion``
-    - install-time macro expansion in %pre %post %preun %postun scripts (see: https://rpm.org/user_doc/scriptlet_expansion.html)
-* ``--[no-]rpm-sign``
-    - Pass --sign to rpmbuild
-* ``--[no-]rpm-use-file-permissions``
-    - Use existing file permissions when defining ownership and modes.
-* ``--[no-]rpm-verbatim-gem-dependencies``
-    - When converting from a gem, leave the old (fpm 0.4.x) style dependency names. This flag will use the old 'rubygem-foo' names in rpm requires instead of the redhat style rubygem(foo).
-* ``--rpm-attr ATTRFILE``
-    - Set the attribute for a file (%attr), e.g. --rpm-attr 750,user1,group1:/some/file
-* ``--rpm-auto-add-exclude-directories DIRECTORIES``
-    - Additional directories ignored by '--rpm-auto-add-directories' flag
 * ``--rpm-changelog FILEPATH``
     - Add changelog from FILEPATH contents
 * ``--rpm-compression none|xz|xzmt|gzip|bzip2``
@@ -40,8 +30,12 @@
     - Set %filter_from_requires to the supplied REGEX.
 * ``--rpm-group GROUP``
     - Set the group to GROUP in the %files section. Overrides the group when used with use-file-permissions setting.
+* ``--[no-]rpm-ignore-iteration-in-dependencies``
+    - For '=' (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted
 * ``--rpm-init FILEPATH``
     - Add FILEPATH as an init script
+* ``--[no-]rpm-macro-expansion``
+    - install-time macro expansion in %pre %post %preun %postun scripts (see: https://rpm.org/user_doc/scriptlet_expansion.html)
 * ``--rpm-os OS``
     - The operating system to target this rpm for. You want to set this to 'linux' if you are using fpm on OS X, for example
 * ``--rpm-posttrans FILE``
@@ -50,6 +44,8 @@
     - pretrans script
 * ``--rpm-rpmbuild-define DEFINITION``
     - Pass a --define argument to rpmbuild.
+* ``--[no-]rpm-sign``
+    - Pass --sign to rpmbuild
 * ``--rpm-summary SUMMARY``
     - Set the RPM summary. Overrides the first line on the description if set
 * ``--rpm-tag TAG``
@@ -62,8 +58,12 @@
     - Adds a rpm trigger script located in FILEPATH, having 'OPT' options and linking to 'PACKAGE'. PACKAGE can be a comma seperated list of packages. See: http://rpm.org/api/4.4.2.2/triggers.html
 * ``--rpm-trigger-before-uninstall '[OPT]PACKAGE: FILEPATH'``
     - Adds a rpm trigger script located in FILEPATH, having 'OPT' options and linking to 'PACKAGE'. PACKAGE can be a comma seperated list of packages. See: http://rpm.org/api/4.4.2.2/triggers.html
+* ``--[no-]rpm-use-file-permissions``
+    - Use existing file permissions when defining ownership and modes.
 * ``--rpm-user USER``
     - Set the user to USER in the %files section. Overrides the user when used with use-file-permissions setting.
+* ``--[no-]rpm-verbatim-gem-dependencies``
+    - When converting from a gem, leave the old (fpm 0.4.x) style dependency names. This flag will use the old 'rubygem-foo' names in rpm requires instead of the redhat style rubygem(foo).
 * ``--rpm-verifyscript FILE``
     - a script to be run on verification
 

docs/packages/cli/virtualenv.rst

@@ -1,11 +1,7 @@
-* ``--[no-]virtualenv-fix-name``
-    - Should the target package name be prefixed?
-* ``--[no-]virtualenv-setup-install``
-    - After building virtualenv run setup.py install useful when building a virtualenv for packages and including their requirements from 
-* ``--[no-]virtualenv-system-site-packages``
-    - Give the virtual environment access to the global site-packages
 * ``--virtualenv-find-links PIP_FIND_LINKS``
     - 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.
+* ``--[no-]virtualenv-fix-name``
+    - Should the target package name be prefixed?
 * ``--virtualenv-install-location DIRECTORY``
     - DEPRECATED: Use --prefix instead.  Location to which to install the virtualenv by default.
 * ``--virtualenv-other-files-dir DIRECTORY``
@@ -16,4 +12,8 @@
     - PyPi Server uri for retrieving packages.
 * ``--virtualenv-pypi-extra-url PYPI_EXTRA_URL``
     - PyPi extra-index-url for pointing to your priviate PyPi
+* ``--[no-]virtualenv-setup-install``
+    - After building virtualenv run setup.py install useful when building a virtualenv for packages and including their requirements from 
+* ``--[no-]virtualenv-system-site-packages``
+    - Give the virtual environment access to the global site-packages