Fossil

Check-in [5cb3e094]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Clarity, formatting, and grammar edit pass on the new www/mirrortogithub.md document.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 5cb3e09464866829b8c54ef9a8882d9615c5d93759e09342128de926533724f4
User & Date: wyoung 2019-03-17 04:21:20
Context
2019-03-17
05:05
Added information on 2FA to the new mirroringtogithub.md doc check-in: a2ef4310 user: wyoung tags: trunk
04:21
Clarity, formatting, and grammar edit pass on the new www/mirrortogithub.md document. check-in: 5cb3e094 user: wyoung tags: trunk
03:50
Only showing the file name extension to MIME type map page on the sitemap if the accessing user has an ability to check in named files. I can't see how anyone else would care what that table contains. check-in: 71d66284 user: wyoung tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to www/mirrortogithub.md.

     1      1   # How To Mirror A Fossil Repository On GitHub
     2      2   
     3         -Beginning with Fossil version 2.9, can mirror a Fossil-based
            3  +Beginning with Fossil version 2.9, you can mirror a Fossil-based
     4      4   project on GitHub by following these steps:
     5      5   
     6      6   <ol>
     7      7   <li><p>Create an account on GitHub if you do not have one already.  Log
     8      8       into that account.
     9      9   
    10     10   <li><p>Create a new project.  GitHub will ask you if you want to prepopulate
................................................................................
    17     17   https://github.com/username/project.git
    18     18   </blockquote>
    19     19   
    20     20   <li><p>Back on your workstation, move to a checkout for your project and
    21     21       type:
    22     22   
    23     23   <blockquote>
    24         -fossil git export GITREPO --autopush https://<font color="orange">username</font>:<font color="red">password</font>@github.com/username/project.git
           24  +<pre>$ fossil git export /path/to/git/repo --autopush \
           25  +  https://<font color="orange">username</font>:<font color="red">password</font>@github.com/username/project.git</pre>
    25     26   </blockquote>
    26     27   
    27         -<p>   In place of GITREPO above, put in some directory name that is not
    28         -      part of your source tree.  The directory need not exist - Fossil will
    29         -      create it if necessary.  This GITREPO directory will become a Git
    30         -      repository that holds a translation of your Fossil repository.
           28  +<p>   In place of the <code>/path/to...</code> argument above, put in some
           29  +      directory name that is <i>outside</i> of your Fossil checkout.  Fossil
           30  +      will create this directory if necessary.  This directory will
           31  +      become a Git repository that holds a translation of your Fossil
           32  +      repository.
    31     33   
    32         -<p>   The --autopush option tells Fossil that you want to push the Git
    33         -      translation up to GitHub every time it is updated.
    34         -      Note that you will need to augment the URL supplied by GitHub
    35         -      to insert your account <font color="orange">username</font>
    36         -      and <font color="red">password</font>.
           34  +<p>   The <code>--autopush</code> option tells Fossil that you want to
           35  +      push the Git translation up to GitHub every time it is updated.  Note
           36  +      that you will need to augment the URL supplied by GitHub to insert
           37  +      your account <font color="orange">username</font> and <font
           38  +      color="red">password</font>.
    37     39   
    38         -<p>   You can also run the command above outside of any open checkout
    39         -      of your project by supplying the "-R repository" option.
           40  +<p>   You can also run the command above outside of any open checkout of
           41  +      your project by supplying the “<code>-R&nbsp;repository</code>”
           42  +      option.
    40     43   
    41     44   <li><p>Get some coffee.  Depending on the size of your project, the
    42     45          command above can run for several minutes.
    43     46   
    44     47   <li><p>And you are done!  Assuming everything worked, your project is now
    45     48       mirrored on GitHub.
    46     49   
    47     50   <li><p>Whenever you update your project, simply run this command to update
    48     51       the mirror:
    49     52   
    50     53   <blockquote>
    51         -fossil git export
           54  +<pre>$ fossil git export</pre>
    52     55   </blockquote>
    53     56   
    54     57   
    55         -<p>   When updating your project, you do not need to reenter the GITREPO
    56         -      or the --autopush.  Fossil remembers those things.  The initial
    57         -      mirroring operation probably took several minutes (or tens of minutes)
    58         -      but a typical update will happen in a second or less.
           58  +<p>   Unlike with the first time you ran that command, you don’t need
           59  +      the remaining arguments, because Fossil remembers those things.
           60  +      Subsequent mirror updates should happen in a second or less.
    59     61   </ol>
    60     62   
    61     63   ## Notes:
    62     64   
    63     65     *  The mirroring is one-way.  If you check in changes on GitHub, those
    64     66        changes will not be reabsorbed by Fossil.  There are technical problems
    65     67        that make a two-way mirror all but impossible.
    66     68   
    67         -  *  The "fossil git export" command creates subprocesses that run "git"
    68         -     commands.  So you must have Git installed on your machine for any
           69  +     This also means that you cannot accept pull requests on GitHub.
           70  +
           71  +  *  The "`fossil git export`" command creates subprocesses that run "`git`"
           72  +     commands, so you must have Git installed on your machine for any
    69     73        of this to work.
    70     74   
    71     75     *  The Git repository will have an extra unmanaged top-level directory named
    72     76        "`.mirror_state`" that contains one or more files.  Those files are
    73     77        used to store the intermediate state of the translation so that
    74         -     subsequent invocations of "fossil git export" will know where you
    75         -     left of last time and what new content needs to be moved over into
           78  +     subsequent invocations of "`fossil git export`" will know where you
           79  +     left off the last time and what new content needs to be moved over into
    76     80        Git.  Be careful not to mess with the `.mirror_state` directory or
    77         -     any of its contents.  Do not manages those files.  Do not edit or
    78         -     delete them.
           81  +     any of its contents.  Do not put those files under Git management.  Do
           82  +     not edit or delete them.
    79     83   
    80     84     *  Only check-ins and simple tags are translated to Git.  Git does not
    81     85        support wiki or tickets or unversioned content or any of the other
    82     86        features of Fossil that make it so convenient to use, so those other
    83     87        elements cannot be mirrored in Git.
    84     88   
    85     89     *  In Git, all tags must be unique.  If your Fossil repository has the
    86     90        same tag on two or more check-ins, the tag will only be preserved on
    87     91        the chronologically newest check-in.
    88     92   
    89     93   ## Example GitHub Mirrors
    90     94   
    91         -As of this writing (2019-03-16) the Fossil self-repository is mirrored
           95  +As of this writing (2019-03-16) Fossil’s own repository is mirrored
    92     96   on GitHub at:
    93     97   
    94     98   >
    95     99   <https://github.com/drhsqlite/fossil-mirror>
    96    100   
    97    101   In addition, an experimental SQLite mirror is available:
    98    102