Fossil SCM

Add documentation for "fossil patch"

drh 2021-06-22 13:30 patch-cmd
Commit 169346a1aa0aa624165091c25a0765a6df30f62ae7a88d2c9729e96da0b21b0e
Parent a534422e89fc2b4…
5 files changed +3 +1 +1 +21 +1
~ src/patch.c ~ www/changes.wiki ~ www/mkindex.tcl + www/patchcmd.md ~ www/permutedindex.html
M src/patch.c
+3
--- src/patch.c
+++ src/patch.c
@@ -646,10 +646,13 @@
646646
 ** REMOTE-CHECKOUT is in one of the following formats:
647647
 **
648648
 ** * DIRECTORY
649649
 ** * HOST:DIRECTORY
650650
 ** * USER@HOST:DIRECTORY
651
+**
652
+** This command will only work if "fossil" is on the default PATH
653
+** of the remote machine.
651654
 **
652655
 ** > fossil patch pull REMOTE-CHECKOUT
653656
 **
654657
 ** Create a patch on a remote check-out, transfer that patch to the
655658
 ** local machine (using ssh) and apply the patch in the local checkout.
656659
--- src/patch.c
+++ src/patch.c
@@ -646,10 +646,13 @@
646 ** REMOTE-CHECKOUT is in one of the following formats:
647 **
648 ** * DIRECTORY
649 ** * HOST:DIRECTORY
650 ** * USER@HOST:DIRECTORY
 
 
 
651 **
652 ** > fossil patch pull REMOTE-CHECKOUT
653 **
654 ** Create a patch on a remote check-out, transfer that patch to the
655 ** local machine (using ssh) and apply the patch in the local checkout.
656
--- src/patch.c
+++ src/patch.c
@@ -646,10 +646,13 @@
646 ** REMOTE-CHECKOUT is in one of the following formats:
647 **
648 ** * DIRECTORY
649 ** * HOST:DIRECTORY
650 ** * USER@HOST:DIRECTORY
651 **
652 ** This command will only work if "fossil" is on the default PATH
653 ** of the remote machine.
654 **
655 ** > fossil patch pull REMOTE-CHECKOUT
656 **
657 ** Create a patch on a remote check-out, transfer that patch to the
658 ** local machine (using ssh) and apply the patch in the local checkout.
659
M www/changes.wiki
+1
--- www/changes.wiki
+++ www/changes.wiki
@@ -3,10 +3,11 @@
33
 <a name='v2_16'></a>
44
 <h2>Changes for Version 2.16 (pending)</h2>
55
 * <b>Security:</b> Fix the client-side TLS so that it verifies that the
66
 server hostname matches its certificate. <b>Upgrading to
77
 the patch is recommended.</b>
8
+ * Added the [./patchcmd.md|fossil patch] command.
89
 * The [/brlist|/brlist web page] allows the user to
910
 select multiple branches to be displayed together in a single
1011
 timeline.
1112
 * The [./forum.wiki|Forum] provides a hyperlink on the author of each
1213
 post that goes to a timeline of recent posts by that same author.
1314
--- www/changes.wiki
+++ www/changes.wiki
@@ -3,10 +3,11 @@
3 <a name='v2_16'></a>
4 <h2>Changes for Version 2.16 (pending)</h2>
5 * <b>Security:</b> Fix the client-side TLS so that it verifies that the
6 server hostname matches its certificate. <b>Upgrading to
7 the patch is recommended.</b>
 
8 * The [/brlist|/brlist web page] allows the user to
9 select multiple branches to be displayed together in a single
10 timeline.
11 * The [./forum.wiki|Forum] provides a hyperlink on the author of each
12 post that goes to a timeline of recent posts by that same author.
13
--- www/changes.wiki
+++ www/changes.wiki
@@ -3,10 +3,11 @@
3 <a name='v2_16'></a>
4 <h2>Changes for Version 2.16 (pending)</h2>
5 * <b>Security:</b> Fix the client-side TLS so that it verifies that the
6 server hostname matches its certificate. <b>Upgrading to
7 the patch is recommended.</b>
8 * Added the [./patchcmd.md|fossil patch] command.
9 * The [/brlist|/brlist web page] allows the user to
10 select multiple branches to be displayed together in a single
11 timeline.
12 * The [./forum.wiki|Forum] provides a hyperlink on the author of each
13 post that goes to a timeline of recent posts by that same author.
14
M www/mkindex.tcl
+1
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -83,10 +83,11 @@
8383
 makefile.wiki {The Fossil Build Process}
8484
 mirrorlimitations.md {Limitations On Git Mirrors}
8585
 mirrortogithub.md {How To Mirror A Fossil Repository On GitHub}
8686
 /md_rules {Markdown Formatting Rules}
8787
 newrepo.wiki {How To Create A New Fossil Repository}
88
+ patchcmd.md {The "fossil patch" Command}
8889
 password.wiki {Password Management And Authentication}
8990
 pikchr.md {The Pikchr Diagram Language}
9091
 pop.wiki {Principles Of Operation}
9192
 private.wiki {Creating, Syncing, and Deleting Private Branches}
9293
 qandc.wiki {Questions And Criticisms}
9394
9495
ADDED www/patchcmd.md
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -83,10 +83,11 @@
83 makefile.wiki {The Fossil Build Process}
84 mirrorlimitations.md {Limitations On Git Mirrors}
85 mirrortogithub.md {How To Mirror A Fossil Repository On GitHub}
86 /md_rules {Markdown Formatting Rules}
87 newrepo.wiki {How To Create A New Fossil Repository}
 
88 password.wiki {Password Management And Authentication}
89 pikchr.md {The Pikchr Diagram Language}
90 pop.wiki {Principles Of Operation}
91 private.wiki {Creating, Syncing, and Deleting Private Branches}
92 qandc.wiki {Questions And Criticisms}
93
94 DDED www/patchcmd.md
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -83,10 +83,11 @@
83 makefile.wiki {The Fossil Build Process}
84 mirrorlimitations.md {Limitations On Git Mirrors}
85 mirrortogithub.md {How To Mirror A Fossil Repository On GitHub}
86 /md_rules {Markdown Formatting Rules}
87 newrepo.wiki {How To Create A New Fossil Repository}
88 patchcmd.md {The "fossil patch" Command}
89 password.wiki {Password Management And Authentication}
90 pikchr.md {The Pikchr Diagram Language}
91 pop.wiki {Principles Of Operation}
92 private.wiki {Creating, Syncing, and Deleting Private Branches}
93 qandc.wiki {Questions And Criticisms}
94
95 DDED www/patchcmd.md
A www/patchcmd.md
+21
--- a/www/patchcmd.md
+++ b/www/patchcmd.md
@@ -0,0 +1,21 @@
1
+# The "fossil patch" command?cmd=
2
+The "[fossil patch](/help/patch)" command is designed to transfer
3
+uncommitted changes from one check-out to another, including transfering
4
+those changes to other machines.
5
+
6
+For example, if you are working on a Windows desktop and you want to
7
+test your changes on a Linux server before you commit, you can use the
8
+"fossil patch push" command to make a copy of all your changes, where they can be tested.on>the
9
+remote Linux server:
10
+
11
+ fossil patch push linuxserver:/path/to"linuxserver" is the name of the remote machine and
12
+"/path/to/checkout" is an existing checkout directory for the same project
13
+on the remote machine.
14
+
15
+The "fossil patch push" command works by first creating a patch file,
16
+then transfering that patch file to the remote machine using "ssh", then
17
+applying the patch. If you do not have ssh available, you can break these
18
+steps apart as follows:
19
+
20
+ 1. On the local machine: `fossil patch create mypatch.patch`
21
+ 2. Move "mypatch.patch"
--- a/www/patchcmd.md
+++ b/www/patchcmd.md
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/patchcmd.md
+++ b/www/patchcmd.md
@@ -0,0 +1,21 @@
1 # The "fossil patch" command?cmd=
2 The "[fossil patch](/help/patch)" command is designed to transfer
3 uncommitted changes from one check-out to another, including transfering
4 those changes to other machines.
5
6 For example, if you are working on a Windows desktop and you want to
7 test your changes on a Linux server before you commit, you can use the
8 "fossil patch push" command to make a copy of all your changes, where they can be tested.on>the
9 remote Linux server:
10
11 fossil patch push linuxserver:/path/to"linuxserver" is the name of the remote machine and
12 "/path/to/checkout" is an existing checkout directory for the same project
13 on the remote machine.
14
15 The "fossil patch push" command works by first creating a patch file,
16 then transfering that patch file to the remote machine using "ssh", then
17 applying the patch. If you do not have ssh available, you can break these
18 steps apart as follows:
19
20 1. On the local machine: `fossil patch create mypatch.patch`
21 2. Move "mypatch.patch"
M www/permutedindex.html
+1
--- www/permutedindex.html
+++ www/permutedindex.html
@@ -106,10 +106,11 @@
106106
 <li><a href="shunning.wiki">Shunning: Deleting Content From Fossil</a></li>
107107
 <li><a href="../../../sitemap">Site Map</a></li>
108108
 <li><a href="style.wiki">Source Code Style Guidelines</a></li>
109109
 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
110110
 <li><a href="backoffice.md">The "Backoffice" mechanism of Fossil</a></li>
111
+<li><a href="patchcmd.md">The "fossil patch" Command</a></li>
111112
 <li><a href="blame.wiki">The Annotate/Blame Algorithm Of Fossil</a></li>
112113
 <li><a href="defcsp.md">The Default Content Security Policy</a></li>
113114
 <li><a href="fileedit-page.md">The fileedit Page</a></li>
114115
 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
115116
 <li><a href="sync.wiki">The Fossil Sync Protocol</a></li>
116117
--- www/permutedindex.html
+++ www/permutedindex.html
@@ -106,10 +106,11 @@
106 <li><a href="shunning.wiki">Shunning: Deleting Content From Fossil</a></li>
107 <li><a href="../../../sitemap">Site Map</a></li>
108 <li><a href="style.wiki">Source Code Style Guidelines</a></li>
109 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
110 <li><a href="backoffice.md">The "Backoffice" mechanism of Fossil</a></li>
 
111 <li><a href="blame.wiki">The Annotate/Blame Algorithm Of Fossil</a></li>
112 <li><a href="defcsp.md">The Default Content Security Policy</a></li>
113 <li><a href="fileedit-page.md">The fileedit Page</a></li>
114 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
115 <li><a href="sync.wiki">The Fossil Sync Protocol</a></li>
116
--- www/permutedindex.html
+++ www/permutedindex.html
@@ -106,10 +106,11 @@
106 <li><a href="shunning.wiki">Shunning: Deleting Content From Fossil</a></li>
107 <li><a href="../../../sitemap">Site Map</a></li>
108 <li><a href="style.wiki">Source Code Style Guidelines</a></li>
109 <li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
110 <li><a href="backoffice.md">The "Backoffice" mechanism of Fossil</a></li>
111 <li><a href="patchcmd.md">The "fossil patch" Command</a></li>
112 <li><a href="blame.wiki">The Annotate/Blame Algorithm Of Fossil</a></li>
113 <li><a href="defcsp.md">The Default Content Security Policy</a></li>
114 <li><a href="fileedit-page.md">The fileedit Page</a></li>
115 <li><a href="makefile.wiki">The Fossil Build Process</a></li>
116 <li><a href="sync.wiki">The Fossil Sync Protocol</a></li>
117

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button