Changeset b4be4cf1 for general/prog/gitserver.xml

Timestamp:

01/08/2021 06:46:05 PM (3 years ago)

Author:

Bruce Dubbs <bdubbs@…>

Branches:

10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal

Children:

7c9ae62

Parents:

c5e3c1c

Message:

More tweaks to git server page

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24092 af4574ff-66df-0310-9fd7-8a98e5e911e0

File:

• general/prog/gitserver.xml (modified) (8 diffs)

general/prog/gitserver.xml

@@ -77 +77 @@
         For any developer who should have access to the repository
         add his/her public ssh key to <filename>/home/git/.ssh/authorized_keys</filename>.
-        First, prepend some options to prevent users to use the
+        First, prepend some options to prevent users from using the
         connection to git for port forwarding to other machines
         the git server might reach.
@@ -117 +117 @@
       </para>
 
+      <note>
+        <para>
+          In all the instructions below, we use <emphasis>project1</emphasis>
+          as an example repository name.  You should name your repository 
+          as a short descriptive name for your specific project.
+        </para>
+      </note>
+
 <screen role="root"><userinput>install -o git -g git -m755 -d /srv/git/project1.git &amp;&amp;
 cd /srv/git/project1.git                             &amp;&amp;
@@ -127 +135 @@
       <title>3. Populate the repository from a client system</title>
 
+      <note>
+        <para>
+          All the instructions in this section and the next should
+          be done on a user system, not the server system.
+        </para>
+      </note>
+
       <para>
         Now that the repository is created, it can be used by the
@@ -150 +165 @@
         to the repository as the initial content:
       </para>
+
+      <note>
+        <para>
+          The <emphasis>gitserver</emphasis> term used below 
+          should be the host name (or ip address) of the git server. 
+        </para>
+      </note>
 
 <screen role="nodump"><userinput>mkdir myproject
@@ -199 +221 @@
         <filename>authorized_keys</filename> file and there is no
         option for the public to export/clone the repository. To
-        enable this, continue with step 4 to setup the git server.
+        enable this, continue with step 4 to set up the git server
+        for public read-only access.
       </para>
 
@@ -210 +233 @@
         The setup described above makes a repository available for
         authenticated users (via providing the ssh public key file).
-        There is also a quite simple way to publish the 
+        There is also a simple way to publish the 
         repository to unauthenticated users - of course without write
         access.
@@ -253 +276 @@
 
       <para>
-        In order to make <application>git</application> exporting a
+        In order to allow <application>git</application> to export a
         repository, a file named <filename>git-daemon-export-ok</filename>
         is required in each repository directory on the server. The
@@ -263 +286 @@
 
       <para>
-        Also review the configuration file
+        Finally, review the configuration file
         <filename revision="sysv">/etc/sysconfig/git-daemon</filename>
         <filename revision="systemd">/etc/default/git-daemon</filename>
-        for valid repository paths.
+        for valid repository paths and change them as appropriate.
       </para>