Fix digest mismatch error

[gocheese.git] / gocheese.texi

diff --git a/gocheese.texi b/gocheese.texi
index e1a796681e268f8c574da77124faf303f10d81f4..26ab1789dd4a75f1daa548d93789738c5b8cd103 100644 (file)
--- a/gocheese.texi
+++ b/gocheese.texi
@@ -31,7 +31,7 @@ but nearly all the code was rewritten. It has huge differences:
     packaged
 @item graceful HTTP-server shutdown
 @item no YAML configuration, just command-line arguments
-@item no package overwriting ability (as PyPI does)
+@item no package overwriting ability (as PyPI does too)
 @end itemize
 
 Also it contains @file{pyshop2packages.sh} migration script for
@@ -59,12 +59,16 @@ To use it for download purposes, just configure your @file{pip.conf}:
 index-url = http://gocheese.host:8080/simple/
 @end verbatim
 
-@option{-refresh} URL behaves the same way as @option{-simple} one, but
-is always refreshes package versions from PyPI when listing it. You can
-use it to forcefully update known package versions.
+@option{-refresh} URL (@code{/simple/} by default) automatically
+refreshes metainformation (available versions and their checksums)
+from the upstream, when queried for package directory listing.
+@option{-norefresh} prevents upstream queries.
 
-You can upload packages to it with
-@url{https://pypi.org/project/twine/, twine}:
+@option{-gpgupdate} is useful mainly for migrated for Pyshop migrated
+repositories. It forces GPG signature files downloading for all existing
+package files.
+
+You can upload packages to it with @url{https://pypi.org/project/twine/, twine}:
 
 @verbatim
 twine upload
@@ -73,12 +77,21 @@ twine upload
     --password foo dist/tarball.tar.gz
 @end verbatim
 
+Or you can store it permanently in @file{.pypirc}:
+
+@verbatim
+[pypi]
+repository: https://gocheese.host/simple/
+username: spam
+password: foo
+@end verbatim
+
 If @command{twine} sends SHA256 checksum in the request, then uploaded
 file is checked against it.
 
-@option{-gpgupdate} is useful mainly for migrated from Pyshop
-repositories. It forces GPG signature files downloading for all existing
-package files.
+Pay attention that you have to manually create corresponding private
+package directory! You are not allowed to upload anything explicitly
+flagged as private.
 
 @node Passwords
 @unnumbered Password authentication
@@ -172,9 +185,10 @@ root
   +-- public-package
   |     +- public-package-0.1.tar.gz.sha256
   |     +- public-package-0.2.tar.gz
+  |     +- public-package-0.2.tar.gz.asc
   |     +- public-package-0.2.tar.gz.sha256
   +-- private-package
-  |     +- .private
+  |     +- .internal
   |     +- private-package-0.1.tar.gz
   |     +- private-package-0.1.tar.gz.sha256
   |...
@@ -189,8 +203,10 @@ files. However no package package tarball is downloaded.
 When you request for particular package version, then its tarball is
 downloaded and verified against the checksum. For example in the root
 directory above we have downloaded only @file{public-package-0.2}.
+If upstream has corresponding @file{.asc} file, then it also will be
+downloaded.
 
-Private packages contain @file{.private} file, indicating that it must
+Private packages contain @file{.internal} file, indicating that it must
 not be asked in PyPI if required version is missing. You have to create
 it manually.