Fossil SCM
Add documentation for the new '--attribute' option introduced with check-in [cd4fbdee00], 'fx_git' repository database table that's created when it's used, and subsequent operational changes to 'git export' and incremental 'import --git' calls.
Commit
dd15d28d89d472a1ff8a45080895bd5aca284a562dab33cf8abd5c1e82116a7c
Parent
806c6f60c44e0ed…
2 files changed
+10
+17
+10
| --- www/inout.wiki | ||
| +++ www/inout.wiki | ||
| @@ -24,10 +24,20 @@ | ||
| 24 | 24 | is currently the only VCS interchange format that Fossil understands. But |
| 25 | 25 | future versions of Fossil might be enhanced to understand other VCS |
| 26 | 26 | interchange formats, and so for compatibility, use of the |
| 27 | 27 | --git option is recommended. |
| 28 | 28 | |
| 29 | +<a name="fx_git"></a> | |
| 30 | +Note that in new imports, Fossil defaults to using the email component of the | |
| 31 | +Git <em>committer</em> (or <em>author</em> if <code>--use-author</code> is | |
| 32 | +passed) to attribute check-ins in the imported repository. Alternatively, the | |
| 33 | +[/help?cmd=import | <code>--attribute</code>] option can be passed to have all | |
| 34 | +commits by a given committer attributed to a desired username. This will create | |
| 35 | +and populate the new <code>fx_git</code> table in the repository database to | |
| 36 | +maintain a record of correspondent usernames and email addresses that can be | |
| 37 | +used in subsequent exports or incremental imports. | |
| 38 | + | |
| 29 | 39 | <h2>Fossil → Git</h2> |
| 30 | 40 | |
| 31 | 41 | To convert a Fossil repository into a Git repository, run commands like |
| 32 | 42 | this: |
| 33 | 43 | |
| 34 | 44 |
| --- www/inout.wiki | |
| +++ www/inout.wiki | |
| @@ -24,10 +24,20 @@ | |
| 24 | is currently the only VCS interchange format that Fossil understands. But |
| 25 | future versions of Fossil might be enhanced to understand other VCS |
| 26 | interchange formats, and so for compatibility, use of the |
| 27 | --git option is recommended. |
| 28 | |
| 29 | <h2>Fossil → Git</h2> |
| 30 | |
| 31 | To convert a Fossil repository into a Git repository, run commands like |
| 32 | this: |
| 33 | |
| 34 |
| --- www/inout.wiki | |
| +++ www/inout.wiki | |
| @@ -24,10 +24,20 @@ | |
| 24 | is currently the only VCS interchange format that Fossil understands. But |
| 25 | future versions of Fossil might be enhanced to understand other VCS |
| 26 | interchange formats, and so for compatibility, use of the |
| 27 | --git option is recommended. |
| 28 | |
| 29 | <a name="fx_git"></a> |
| 30 | Note that in new imports, Fossil defaults to using the email component of the |
| 31 | Git <em>committer</em> (or <em>author</em> if <code>--use-author</code> is |
| 32 | passed) to attribute check-ins in the imported repository. Alternatively, the |
| 33 | [/help?cmd=import | <code>--attribute</code>] option can be passed to have all |
| 34 | commits by a given committer attributed to a desired username. This will create |
| 35 | and populate the new <code>fx_git</code> table in the repository database to |
| 36 | maintain a record of correspondent usernames and email addresses that can be |
| 37 | used in subsequent exports or incremental imports. |
| 38 | |
| 39 | <h2>Fossil → Git</h2> |
| 40 | |
| 41 | To convert a Fossil repository into a Git repository, run commands like |
| 42 | this: |
| 43 | |
| 44 |
+17
| --- www/mirrortogithub.md | ||
| +++ www/mirrortogithub.md | ||
| @@ -124,10 +124,27 @@ | ||
| 124 | 124 | [long list of restrictions](https://git-scm.com/docs/git-check-ref-format) |
| 125 | 125 | on tag and branch names in Git. If any of your Fossil tag or branch names |
| 126 | 126 | violate these rules, then the names are translated prior to being exported |
| 127 | 127 | to Git. The translation usually involves converting the offending characters |
| 128 | 128 | into underscores. |
| 129 | + | |
| 130 | + * If your Fossil user contact info is not set and this repository was not | |
| 131 | + initially [imported from Git](./inout.wiki), `fossil git export` will | |
| 132 | + construct a generic `[email protected]` for the Git *committer* and *author* | |
| 133 | + email fields of each commit. However, Fossil will first attempt to parse an | |
| 134 | + email address from your user contact info, which can be set through a | |
| 135 | + Fossil [UI][ui] browser window or with the [`user contact`][usercmd] | |
| 136 | + subcommand on the command line. Alternatively, if this repository was | |
| 137 | + previously imported from Git using the [`--attribute`][attr] option, the | |
| 138 | + [`fx_git`][fxgit] table will be queried for correspondent email addresses. | |
| 139 | + Only if neither of these methods produce a user specified email will the | |
| 140 | + abovementioned generic address be used. | |
| 141 | + | |
| 142 | +[attr]: /help?cmd=import | |
| 143 | +[fxgit]: ./inout.wiki#fx_git | |
| 144 | +[ui]: /help?cmd=ui | |
| 145 | +[usercmd]: /help?cmd=user | |
| 129 | 146 | |
| 130 | 147 | <a name='ex1'></a> |
| 131 | 148 | ## Example GitHub Mirrors |
| 132 | 149 | |
| 133 | 150 | As of this writing (2019-03-16) Fossil’s own repository is mirrored |
| 134 | 151 |
| --- www/mirrortogithub.md | |
| +++ www/mirrortogithub.md | |
| @@ -124,10 +124,27 @@ | |
| 124 | [long list of restrictions](https://git-scm.com/docs/git-check-ref-format) |
| 125 | on tag and branch names in Git. If any of your Fossil tag or branch names |
| 126 | violate these rules, then the names are translated prior to being exported |
| 127 | to Git. The translation usually involves converting the offending characters |
| 128 | into underscores. |
| 129 | |
| 130 | <a name='ex1'></a> |
| 131 | ## Example GitHub Mirrors |
| 132 | |
| 133 | As of this writing (2019-03-16) Fossil’s own repository is mirrored |
| 134 |
| --- www/mirrortogithub.md | |
| +++ www/mirrortogithub.md | |
| @@ -124,10 +124,27 @@ | |
| 124 | [long list of restrictions](https://git-scm.com/docs/git-check-ref-format) |
| 125 | on tag and branch names in Git. If any of your Fossil tag or branch names |
| 126 | violate these rules, then the names are translated prior to being exported |
| 127 | to Git. The translation usually involves converting the offending characters |
| 128 | into underscores. |
| 129 | |
| 130 | * If your Fossil user contact info is not set and this repository was not |
| 131 | initially [imported from Git](./inout.wiki), `fossil git export` will |
| 132 | construct a generic `[email protected]` for the Git *committer* and *author* |
| 133 | email fields of each commit. However, Fossil will first attempt to parse an |
| 134 | email address from your user contact info, which can be set through a |
| 135 | Fossil [UI][ui] browser window or with the [`user contact`][usercmd] |
| 136 | subcommand on the command line. Alternatively, if this repository was |
| 137 | previously imported from Git using the [`--attribute`][attr] option, the |
| 138 | [`fx_git`][fxgit] table will be queried for correspondent email addresses. |
| 139 | Only if neither of these methods produce a user specified email will the |
| 140 | abovementioned generic address be used. |
| 141 | |
| 142 | [attr]: /help?cmd=import |
| 143 | [fxgit]: ./inout.wiki#fx_git |
| 144 | [ui]: /help?cmd=ui |
| 145 | [usercmd]: /help?cmd=user |
| 146 | |
| 147 | <a name='ex1'></a> |
| 148 | ## Example GitHub Mirrors |
| 149 | |
| 150 | As of this writing (2019-03-16) Fossil’s own repository is mirrored |
| 151 |