Update README.rst and config.py (#470)

* Update README.rst

Add note that the units of `--Cache-Control` is seconds.

* Update config.py

Update `--help` output for `--cache-control` to specify that AGE is in seconds.

---------

Co-authored-by: Dmitrii O <dmtree.dev@yahoo.com>
This commit is contained in:
Samuel Wein 2023-03-07 18:12:06 +01:00 committed by GitHub
parent 754b0f40d7
commit 8cc8e80a88
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions

@ -184,7 +184,7 @@ message *about starting the server*::
use "auto", which chooses one of paste, cherrypy, twisted, or wsgiref. use "auto", which chooses one of paste, cherrypy, twisted, or wsgiref.
-o, --overwrite Allow overwriting existing package files during upload. -o, --overwrite Allow overwriting existing package files during upload.
--welcome HTML_FILE Use the contents of HTML_FILE as a custom welcome message on the home page. --welcome HTML_FILE Use the contents of HTML_FILE as a custom welcome message on the home page.
--cache-control AGE Add "Cache-Control: max-age=AGE" header to package downloads. Pip 6+ requires this for caching. --cache-control AGE Add "Cache-Control: max-age=AGE" header to package downloads. Pip 6+ requires this for caching. AGE is specified in seconds.
--log-req-frmt FORMAT --log-req-frmt FORMAT
A format-string selecting Http-Request properties to log; set to '%s' to see them all. A format-string selecting Http-Request properties to log; set to '%s' to see them all.
--log-res-frmt FORMAT --log-res-frmt FORMAT

@ -453,6 +453,7 @@ def get_parser() -> argparse.ArgumentParser:
help=( help=(
'Add "Cache-Control: max-age=AGE" header to package downloads. ' 'Add "Cache-Control: max-age=AGE" header to package downloads. '
"Pip 6+ requires this for caching." "Pip 6+ requires this for caching."
"AGE is specified in seconds."
), ),
) )
run_parser.add_argument( run_parser.add_argument(