Fossil SCM
Improved documentation of the "fossil sql" command. Add a note to the change log discussing recent enhancements to the "fossil sql" command.
Commit
a52f19674024cc2253a7fdd23b3d30c218ef8c83
Parent
0d28198d0394ab8…
3 files changed
+4
-2
+4
+5
-5
+4
-2
| --- src/sqlcmd.c | ||
| +++ src/sqlcmd.c | ||
| @@ -166,20 +166,22 @@ | ||
| 166 | 166 | } |
| 167 | 167 | |
| 168 | 168 | /* |
| 169 | 169 | ** COMMAND: sqlite3 |
| 170 | 170 | ** |
| 171 | -** Usage: %fossil sqlite3 ?FOSSIL_OPTS? ?DATABASE? ?SHELL_OPTS? | |
| 171 | +** Usage: %fossil sql ?OPTIONS? | |
| 172 | 172 | ** |
| 173 | 173 | ** Run the standalone sqlite3 command-line shell on DATABASE with SHELL_OPTS. |
| 174 | 174 | ** If DATABASE is omitted, then the repository that serves the working |
| 175 | 175 | ** directory is opened. See https://www.sqlite.org/cli.html for additional |
| 176 | 176 | ** information. |
| 177 | 177 | ** |
| 178 | -** Fossil Options: | |
| 178 | +** Options: | |
| 179 | 179 | ** |
| 180 | 180 | ** --no-repository Skip opening the repository database. |
| 181 | +** | |
| 182 | +** -R REPOSITORY Use REPOSITORY as the repository database | |
| 181 | 183 | ** |
| 182 | 184 | ** WARNING: Careless use of this command can corrupt a Fossil repository |
| 183 | 185 | ** in ways that are unrecoverable. Be sure you know what you are doing before |
| 184 | 186 | ** running any SQL commands that modify the repository database. |
| 185 | 187 | ** |
| 186 | 188 |
| --- src/sqlcmd.c | |
| +++ src/sqlcmd.c | |
| @@ -166,20 +166,22 @@ | |
| 166 | } |
| 167 | |
| 168 | /* |
| 169 | ** COMMAND: sqlite3 |
| 170 | ** |
| 171 | ** Usage: %fossil sqlite3 ?FOSSIL_OPTS? ?DATABASE? ?SHELL_OPTS? |
| 172 | ** |
| 173 | ** Run the standalone sqlite3 command-line shell on DATABASE with SHELL_OPTS. |
| 174 | ** If DATABASE is omitted, then the repository that serves the working |
| 175 | ** directory is opened. See https://www.sqlite.org/cli.html for additional |
| 176 | ** information. |
| 177 | ** |
| 178 | ** Fossil Options: |
| 179 | ** |
| 180 | ** --no-repository Skip opening the repository database. |
| 181 | ** |
| 182 | ** WARNING: Careless use of this command can corrupt a Fossil repository |
| 183 | ** in ways that are unrecoverable. Be sure you know what you are doing before |
| 184 | ** running any SQL commands that modify the repository database. |
| 185 | ** |
| 186 |
| --- src/sqlcmd.c | |
| +++ src/sqlcmd.c | |
| @@ -166,20 +166,22 @@ | |
| 166 | } |
| 167 | |
| 168 | /* |
| 169 | ** COMMAND: sqlite3 |
| 170 | ** |
| 171 | ** Usage: %fossil sql ?OPTIONS? |
| 172 | ** |
| 173 | ** Run the standalone sqlite3 command-line shell on DATABASE with SHELL_OPTS. |
| 174 | ** If DATABASE is omitted, then the repository that serves the working |
| 175 | ** directory is opened. See https://www.sqlite.org/cli.html for additional |
| 176 | ** information. |
| 177 | ** |
| 178 | ** Options: |
| 179 | ** |
| 180 | ** --no-repository Skip opening the repository database. |
| 181 | ** |
| 182 | ** -R REPOSITORY Use REPOSITORY as the repository database |
| 183 | ** |
| 184 | ** WARNING: Careless use of this command can corrupt a Fossil repository |
| 185 | ** in ways that are unrecoverable. Be sure you know what you are doing before |
| 186 | ** running any SQL commands that modify the repository database. |
| 187 | ** |
| 188 |
+4
| --- www/changes.wiki | ||
| +++ www/changes.wiki | ||
| @@ -12,10 +12,14 @@ | ||
| 12 | 12 | * Add support for the ms=EXACT|LIKE|GLOB|REGEXP query parameter on the |
| 13 | 13 | [/help?cmd=/timeline|/timeline] webpage, with associated form widgets. |
| 14 | 14 | * Enhance the [/help/changes|changes] and [/help/status|status] commands |
| 15 | 15 | with many new filter options so that specific kinds of changes can be |
| 16 | 16 | found without having to pipe through grep or sed. |
| 17 | + * Enhanced the [/help/sqlite3|fossil sql] command so that it opens the | |
| 18 | + [./tech_overview.wiki#localdb|checkout database] and the | |
| 19 | + [./tech_overview.wiki#configdb|configuration database] in addition to the | |
| 20 | + respository database. | |
| 17 | 21 | * TH1 enhancements: |
| 18 | 22 | <ul><li>Add <nowiki>[unversioned content]</nowiki> command.</li> |
| 19 | 23 | <li>Add <nowiki>[unversioned list]</nowiki> command.</li> |
| 20 | 24 | <li>Add project_description variable.</li> |
| 21 | 25 | </ul> |
| 22 | 26 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -12,10 +12,14 @@ | |
| 12 | * Add support for the ms=EXACT|LIKE|GLOB|REGEXP query parameter on the |
| 13 | [/help?cmd=/timeline|/timeline] webpage, with associated form widgets. |
| 14 | * Enhance the [/help/changes|changes] and [/help/status|status] commands |
| 15 | with many new filter options so that specific kinds of changes can be |
| 16 | found without having to pipe through grep or sed. |
| 17 | * TH1 enhancements: |
| 18 | <ul><li>Add <nowiki>[unversioned content]</nowiki> command.</li> |
| 19 | <li>Add <nowiki>[unversioned list]</nowiki> command.</li> |
| 20 | <li>Add project_description variable.</li> |
| 21 | </ul> |
| 22 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -12,10 +12,14 @@ | |
| 12 | * Add support for the ms=EXACT|LIKE|GLOB|REGEXP query parameter on the |
| 13 | [/help?cmd=/timeline|/timeline] webpage, with associated form widgets. |
| 14 | * Enhance the [/help/changes|changes] and [/help/status|status] commands |
| 15 | with many new filter options so that specific kinds of changes can be |
| 16 | found without having to pipe through grep or sed. |
| 17 | * Enhanced the [/help/sqlite3|fossil sql] command so that it opens the |
| 18 | [./tech_overview.wiki#localdb|checkout database] and the |
| 19 | [./tech_overview.wiki#configdb|configuration database] in addition to the |
| 20 | respository database. |
| 21 | * TH1 enhancements: |
| 22 | <ul><li>Add <nowiki>[unversioned content]</nowiki> command.</li> |
| 23 | <li>Add <nowiki>[unversioned list]</nowiki> command.</li> |
| 24 | <li>Add project_description variable.</li> |
| 25 | </ul> |
| 26 |
+5
-5
| --- www/tech_overview.wiki | ||
| +++ www/tech_overview.wiki | ||
| @@ -104,10 +104,11 @@ | ||
| 104 | 104 | </ul> |
| 105 | 105 | </td> |
| 106 | 106 | </tr> |
| 107 | 107 | </table> |
| 108 | 108 | |
| 109 | +<a name='configdb'></a> | |
| 109 | 110 | <h3>2.1 The Configuration Database</h3> |
| 110 | 111 | |
| 111 | 112 | The configuration database holds cross-repository preferences and a list of all |
| 112 | 113 | repositories for a single user. |
| 113 | 114 | |
| @@ -284,19 +285,18 @@ | ||
| 284 | 285 | |
| 285 | 286 | The shun table can be pushed or pulled using |
| 286 | 287 | the [/help/config | fossil config] command with the "shun" AREA argument. |
| 287 | 288 | The shun table is also copied during a [/help/clone | clone]. |
| 288 | 289 | |
| 290 | +<a name='localdb'></a> | |
| 289 | 291 | <h3>2.3 Checkout Databases</h3> |
| 290 | 292 | |
| 291 | -Unlike several other popular DVCSes, Fossil allows a single repository | |
| 293 | +Fossil allows a single repository | |
| 292 | 294 | to have multiple working checkouts. Each working checkout has a single |
| 293 | 295 | database in its root directory that records the state of that checkout. |
| 294 | -The checkout database is named "_FOSSIL_" by default, but can be renamed | |
| 295 | -to ".fslckout" if desired. (Future versions of Fossil might make | |
| 296 | -".fslckout" the default name.) The checkout database records information | |
| 297 | -such as the following: | |
| 296 | +The checkout database is named "_FOSSIL_" or ".fslckout". | |
| 297 | +The checkout database records information such as the following: | |
| 298 | 298 | |
| 299 | 299 | * The name of the repository database file. |
| 300 | 300 | * The version that is currently checked out. |
| 301 | 301 | * Files that have been [/help/add | added], |
| 302 | 302 | [/help/rm | removed], or [/help/mv | renamed] but not |
| 303 | 303 |
| --- www/tech_overview.wiki | |
| +++ www/tech_overview.wiki | |
| @@ -104,10 +104,11 @@ | |
| 104 | </ul> |
| 105 | </td> |
| 106 | </tr> |
| 107 | </table> |
| 108 | |
| 109 | <h3>2.1 The Configuration Database</h3> |
| 110 | |
| 111 | The configuration database holds cross-repository preferences and a list of all |
| 112 | repositories for a single user. |
| 113 | |
| @@ -284,19 +285,18 @@ | |
| 284 | |
| 285 | The shun table can be pushed or pulled using |
| 286 | the [/help/config | fossil config] command with the "shun" AREA argument. |
| 287 | The shun table is also copied during a [/help/clone | clone]. |
| 288 | |
| 289 | <h3>2.3 Checkout Databases</h3> |
| 290 | |
| 291 | Unlike several other popular DVCSes, Fossil allows a single repository |
| 292 | to have multiple working checkouts. Each working checkout has a single |
| 293 | database in its root directory that records the state of that checkout. |
| 294 | The checkout database is named "_FOSSIL_" by default, but can be renamed |
| 295 | to ".fslckout" if desired. (Future versions of Fossil might make |
| 296 | ".fslckout" the default name.) The checkout database records information |
| 297 | such as the following: |
| 298 | |
| 299 | * The name of the repository database file. |
| 300 | * The version that is currently checked out. |
| 301 | * Files that have been [/help/add | added], |
| 302 | [/help/rm | removed], or [/help/mv | renamed] but not |
| 303 |
| --- www/tech_overview.wiki | |
| +++ www/tech_overview.wiki | |
| @@ -104,10 +104,11 @@ | |
| 104 | </ul> |
| 105 | </td> |
| 106 | </tr> |
| 107 | </table> |
| 108 | |
| 109 | <a name='configdb'></a> |
| 110 | <h3>2.1 The Configuration Database</h3> |
| 111 | |
| 112 | The configuration database holds cross-repository preferences and a list of all |
| 113 | repositories for a single user. |
| 114 | |
| @@ -284,19 +285,18 @@ | |
| 285 | |
| 286 | The shun table can be pushed or pulled using |
| 287 | the [/help/config | fossil config] command with the "shun" AREA argument. |
| 288 | The shun table is also copied during a [/help/clone | clone]. |
| 289 | |
| 290 | <a name='localdb'></a> |
| 291 | <h3>2.3 Checkout Databases</h3> |
| 292 | |
| 293 | Fossil allows a single repository |
| 294 | to have multiple working checkouts. Each working checkout has a single |
| 295 | database in its root directory that records the state of that checkout. |
| 296 | The checkout database is named "_FOSSIL_" or ".fslckout". |
| 297 | The checkout database records information such as the following: |
| 298 | |
| 299 | * The name of the repository database file. |
| 300 | * The version that is currently checked out. |
| 301 | * Files that have been [/help/add | added], |
| 302 | [/help/rm | removed], or [/help/mv | renamed] but not |
| 303 |