Fossil SCM

Improvements to documentation for the "patch" command.

drh 2023-09-19 11:41 trunk
Commit 14ebbe9d99ef2e4a653f3a8ba2868126ce8633c14a7e04ff9697f7d336193de4
Parent ccc780f55261264…
1 file changed +12 -10
~ src/patch.c
M src/patch.c
+12 -10
--- src/patch.c
+++ src/patch.c
@@ -839,36 +839,38 @@
839839
 ** This command is used to create, view, and apply Fossil binary patches.
840840
 ** A Fossil binary patch is a single (binary) file that captures all of the
841841
 ** uncommitted changes of a check-out. Use Fossil binary patches to transfer
842842
 ** proposed or incomplete changes between machines for testing or analysis.
843843
 **
844
-** > fossil patch create [DIRECTORY] FILENAME
844
+** > fossil patch create [DIRECTORY] PATCHFILE
845845
 **
846
-** Create a new binary patch in FILENAME that captures all uncommitted
846
+** Create a new binary patch in PATCHFILE that captures all uncommitted
847847
 ** changes in the check-out at DIRECTORY, or the current directory if
848
-** DIRECTORY is omitted. If FILENAME is "-" then the binary patch
848
+** DIRECTORY is omitted. If PATCHFILE is "-" then the binary patch
849849
 ** is written to standard output.
850850
 **
851851
 ** Options:
852852
 ** -f|--force Overwrite an existing patch with the same name
853853
 **
854
-** > fossil patch apply [DIRECTORY] FILENAME
854
+** > fossil patch apply [DIRECTORY] PATCHFILE
855855
 **
856
-** Apply the changes in FILENAME to the check-out at DIRECTORY, or
856
+** Apply the changes in PATCHFILE to the check-out at DIRECTORY, or
857857
 ** in the current directory if DIRECTORY is omitted.
858858
 **
859859
 ** Options:
860860
 ** -f|--force Apply the patch even though there are unsaved
861861
 ** changes in the current check-out. Unsaved changes
862862
 ** are reverted and permanently lost.
863863
 ** -n|--dry-run Do nothing, but print what would have happened
864864
 ** -v|--verbose Extra output explaining what happens
865865
 **
866
-** > fossil patch diff [DIRECTORY] FILENAME
867
-** > fossil patch gdiff [DIRECTORY] FILENAME
866
+** > fossil patch diff [DIRECTORY] PATCHFILE
867
+** > fossil patch gdiff [DIRECTORY] PATCHFILE
868868
 **
869
-** Show a human-readable diff for the patch. All the usual
869
+** Show a human-readable diff for the patch in PATCHFILE and assocated
870
+** with the the repository checked out in DIRECTORY. The currrent
871
+** directory is used if DIRECTORY is omitted. All the usual
870872
 ** diff flags described at "fossil help diff" apply. With gdiff,
871873
 ** gdiff-command is used instead of internal diff logic. In addition:
872874
 **
873875
 ** -f|--force Continue trying to perform the diff even if
874876
 ** baseline information is missing from the current
@@ -904,13 +906,13 @@
904906
 ** > fossil patch pull REMOTE-CHECKOUT
905907
 **
906908
 ** Like "fossil patch push" except that the transfer is from remote
907909
 ** to local. All the same command-line options apply.
908910
 **
909
-** > fossil patch view FILENAME
911
+** > fossil patch view PATCHFILE
910912
 **
911
-** View a summary of the changes in the binary patch FILENAME.
913
+** View a summary of the changes in the binary patch in PATCHFILE.
912914
 ** Use "fossil patch diff" for detailed patch content.
913915
 **
914916
 ** -v|--verbose Show extra detail about the patch
915917
 **
916918
 */
917919
--- src/patch.c
+++ src/patch.c
@@ -839,36 +839,38 @@
839 ** This command is used to create, view, and apply Fossil binary patches.
840 ** A Fossil binary patch is a single (binary) file that captures all of the
841 ** uncommitted changes of a check-out. Use Fossil binary patches to transfer
842 ** proposed or incomplete changes between machines for testing or analysis.
843 **
844 ** > fossil patch create [DIRECTORY] FILENAME
845 **
846 ** Create a new binary patch in FILENAME that captures all uncommitted
847 ** changes in the check-out at DIRECTORY, or the current directory if
848 ** DIRECTORY is omitted. If FILENAME is "-" then the binary patch
849 ** is written to standard output.
850 **
851 ** Options:
852 ** -f|--force Overwrite an existing patch with the same name
853 **
854 ** > fossil patch apply [DIRECTORY] FILENAME
855 **
856 ** Apply the changes in FILENAME to the check-out at DIRECTORY, or
857 ** in the current directory if DIRECTORY is omitted.
858 **
859 ** Options:
860 ** -f|--force Apply the patch even though there are unsaved
861 ** changes in the current check-out. Unsaved changes
862 ** are reverted and permanently lost.
863 ** -n|--dry-run Do nothing, but print what would have happened
864 ** -v|--verbose Extra output explaining what happens
865 **
866 ** > fossil patch diff [DIRECTORY] FILENAME
867 ** > fossil patch gdiff [DIRECTORY] FILENAME
868 **
869 ** Show a human-readable diff for the patch. All the usual
 
 
870 ** diff flags described at "fossil help diff" apply. With gdiff,
871 ** gdiff-command is used instead of internal diff logic. In addition:
872 **
873 ** -f|--force Continue trying to perform the diff even if
874 ** baseline information is missing from the current
@@ -904,13 +906,13 @@
904 ** > fossil patch pull REMOTE-CHECKOUT
905 **
906 ** Like "fossil patch push" except that the transfer is from remote
907 ** to local. All the same command-line options apply.
908 **
909 ** > fossil patch view FILENAME
910 **
911 ** View a summary of the changes in the binary patch FILENAME.
912 ** Use "fossil patch diff" for detailed patch content.
913 **
914 ** -v|--verbose Show extra detail about the patch
915 **
916 */
917
--- src/patch.c
+++ src/patch.c
@@ -839,36 +839,38 @@
839 ** This command is used to create, view, and apply Fossil binary patches.
840 ** A Fossil binary patch is a single (binary) file that captures all of the
841 ** uncommitted changes of a check-out. Use Fossil binary patches to transfer
842 ** proposed or incomplete changes between machines for testing or analysis.
843 **
844 ** > fossil patch create [DIRECTORY] PATCHFILE
845 **
846 ** Create a new binary patch in PATCHFILE that captures all uncommitted
847 ** changes in the check-out at DIRECTORY, or the current directory if
848 ** DIRECTORY is omitted. If PATCHFILE is "-" then the binary patch
849 ** is written to standard output.
850 **
851 ** Options:
852 ** -f|--force Overwrite an existing patch with the same name
853 **
854 ** > fossil patch apply [DIRECTORY] PATCHFILE
855 **
856 ** Apply the changes in PATCHFILE to the check-out at DIRECTORY, or
857 ** in the current directory if DIRECTORY is omitted.
858 **
859 ** Options:
860 ** -f|--force Apply the patch even though there are unsaved
861 ** changes in the current check-out. Unsaved changes
862 ** are reverted and permanently lost.
863 ** -n|--dry-run Do nothing, but print what would have happened
864 ** -v|--verbose Extra output explaining what happens
865 **
866 ** > fossil patch diff [DIRECTORY] PATCHFILE
867 ** > fossil patch gdiff [DIRECTORY] PATCHFILE
868 **
869 ** Show a human-readable diff for the patch in PATCHFILE and assocated
870 ** with the the repository checked out in DIRECTORY. The currrent
871 ** directory is used if DIRECTORY is omitted. All the usual
872 ** diff flags described at "fossil help diff" apply. With gdiff,
873 ** gdiff-command is used instead of internal diff logic. In addition:
874 **
875 ** -f|--force Continue trying to perform the diff even if
876 ** baseline information is missing from the current
@@ -904,13 +906,13 @@
906 ** > fossil patch pull REMOTE-CHECKOUT
907 **
908 ** Like "fossil patch push" except that the transfer is from remote
909 ** to local. All the same command-line options apply.
910 **
911 ** > fossil patch view PATCHFILE
912 **
913 ** View a summary of the changes in the binary patch in PATCHFILE.
914 ** Use "fossil patch diff" for detailed patch content.
915 **
916 ** -v|--verbose Show extra detail about the patch
917 **
918 */
919

Keyboard Shortcuts

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