commit 951f882f861c44aaaca21462e99f5c11368aa83b
parent f4e79ae74b90116d894e32afd386bda81956153b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 11 Jun 2025 08:46:07 +0200
git-publish: improved unpublish documentation
Notify publicly exposed repositories of HTML index updates.
Make example description more concise to avoid repetition.
Diffstat:
1 file changed, 9 insertions(+), 13 deletions(-)
diff --git a/git-publish.1 b/git-publish.1
@@ -47,10 +47,13 @@ published repositories to update HTML pages on new commits
The options are as follows:
.Bl -tag -width Ds
.It Fl d
-Unpublish repositories: their link in the publicly exposed directory is
-removed, as are their HTML pages and the post-receive hook that updates
-them.
-In other words, the publication process is cancelled.
+Unpublish
+.Ar repositories :
+their link in the publicly exposed directory is removed, as are their
+HTML pages and the post-receive hook that updates them.
+The HTML index of publicly exposed repositories is updated to no longer
+reference repositories to be unpublished.
+If no more repositories are made public, this HTML index is deleted,
.It Fl f
Force HTML generation from scratch.
Enabling this option ensures that HTML pages take into account any
@@ -152,15 +155,8 @@ https://www.example.com/git:
git-publish -u https://www.example.com/git /path/to/repository.git
.Ed
.Pp
-Remove the data that makes the repository public, i.e. unpublish it by
-removing the link to the publicly exposed
-.Pa /srv/git
-.Pq default value of Ev GIT_PUBLISH_DIR_GIT ,
-as well as its HTML pages in the
-.Pa /srv/www/git/
-directory
-.Pq default value of Ev GIT_PUBLISH_DIR_WWW
-and its post-receive hook that updates them:
+Undo the previous publication, i.e. delete the data that made the
+repository public:
.Bd -literal -offset Ds
git-publish -d /path/to/repository.git
.Ed
