Fossil SCM

Fix bullets in wsl_caveats.wiki

larrybr 2022-01-23 12:52 trunk

Commit ea6b2d3e86f1ed881265c1f57aaf563e38ba70bde674c321b869f2578816fadc

Parent c7abbe1ee686bb7…

1 file changed +23 -23

M www/wsl_caveats.wiki

+23 -23

		--- www/wsl_caveats.wiki
		+++ www/wsl_caveats.wiki
		@@ -2,15 +2,15 @@
2	2
3	3	<h2>When These Issues Matter</h2>
4	4
5	5	The discussion following is relevant to those who:
6	6
7		- * Are using the Windows Subsystem for Linux (aka "WSL");
8		- * Create a Fossil checkout in a directory accessible from WSL and Windows;
9		- * Use both Linux Fossil and Windows tools to modify files in a checkout;
10		- * Desire to or must preserve execute permissions set for repository files;
11		- * and Use Linux Fossil to commit changes made within the checkout.
	7	+ * Are using the Windows Subsystem for Linux (aka "WSL");
	8	+ * Create a Fossil checkout in a directory accessible from WSL and Windows;
	9	+ * Use both Linux Fossil and Windows tools to modify files in a checkout;
	10	+ * Desire to or must preserve execute permissions set for repository files;
	11	+ * and Use Linux Fossil to commit changes made within the checkout.
12	12
13	13	Note that these criteria apply conjunctively; if any are not met,
14	14	then the consequences of the issues below are at worst annoying
15	15	and otherwise harmless or absent.
16	16
		@@ -74,65 +74,65 @@
74	74
75	75	<h2>Problematic Usage Scenarios</h2>
76	76
77	77	<h3>A Simple Example</h3>
78	78
79		-* Open a checkout in Windows (using fossil.exe) from a project
	79	+ * Open a checkout in Windows (using fossil.exe) from a project
80	80	whose files have a mixture of executable and non-executable files.
81	81	Use a checkout directory visible when running under WSL.
82	82
83		-* Navigate to the same directory in a Linux shell on WSL, then
	83	+ * Navigate to the same directory in a Linux shell on WSL, then
84	84	run "fossil status".
85	85
86		-* Depending upon /etc/wsl.conf content (or defaults in its absence),
	86	+ * Depending upon /etc/wsl.conf content (or defaults in its absence),
87	87	the status ouput will tag checkout files as EXECUTABLE or NOEXEC.
88	88
89	89	<h3>Continuation of Simple Example</h3>
90	90
91		-* In the same checkout as above "Simple Example", on WSL,
	91	+ * In the same checkout as above "Simple Example", on WSL,
92	92	run "fossil revert" to correct all those errant X-bit values.
93	93
94		-* Run "fossil status" again in WSL to verify absence of toggled X-bits.
	94	+ * Run "fossil status" again in WSL to verify absence of toggled X-bits.
95	95
96		-* Run "ls -l" from WSL to find two files, one with its X-bit set
	96	+ * Run "ls -l" from WSL to find two files, one with its X-bit set
97	97	and the other with it clear.
98	98
99		-* From Windows, perform these steps on each of those files:
100		-(1) read the_file content into a buffer<br>
101		-(2) rename the_file the_file.bak<br>
102		-(3) write buffer content to new file, the_file<br>
103		-(4) del the_file.bak (or leave it)<br>
104		-(Note that this sequence is similar to what many editors do when
	99	+ * From Windows, perform these steps on each of those files:<br>
	100	+  (1) read the_file content into a buffer<br>
	101	+  (2) rename the_file the_file.bak<br>
	102	+  (3) write buffer content to new file, the_file<br>
	103	+  (4) del the_file.bak (or leave it)<br>
	104	+  (Note that this sequence is similar to what many editors do when
105	105	a user modifies a file then uses undo to reverse the changes.)
106	106
107		-* Run "fossil status" again in WSL and observe that one of the
	107	+ * Run "fossil status" again in WSL and observe that one of the
108	108	two files has had its X-bit toggled.
109	109
110	110	<h3>A Fossil-Only Example</h3>
111	111
112		-* In the another (different) checkout of the same version,
	112	+ * In the another (different) checkout of the same version,
113	113	somehow cause "legitimate" X-bit toggles of two files whose
114	114	X-bits differ. (This "somehow" probably will involve WSL to
115	115	toggle file bits and fossil on WSL to commit the toggles.)
116	116
117		-* In the Simple Example checkout, use fossil.exe on Windows
	117	+ * In the Simple Example checkout, use fossil.exe on Windows
118	118	to update the checkout, ostensibly bringing the X-bit toggles
119	119	into the affected checkout files.
120	120
121		-* In the Simple Example checkout, use fossil on WSL to run
	121	+ * In the Simple Example checkout, use fossil on WSL to run
122	122	"fossil status", and observe at least one X-bit discrepancy.
123	123
124	124	<h2>Recommended Workflow</h2>
125	125
126	126	There are two simple approaches for dealing with this issue when
127	127	one wishes to continue using the same checkout directory from
128	128	Windows and WSL. Either one is effective. These are:
129	129
130		-* Do not use fossil on WSL for any operations which will modify
	130	+ * Do not use fossil on WSL for any operations which will modify
131	131	the repository. Instead, block those operations in some manner.
132	132
133		-* Do not use any tools on Windows, (including certain subcommands
	133	+ * Do not use any tools on Windows, (including certain subcommands
134	134	of fossil.exe,) which may modify the X-bits on files within the
135	135	shared checkout, instead restricting use of Windows tools to those
136	136	which are known to only (and actually) modify file content in place
137	137	while preserving X-bit values. (The "actually" proviso emphasizes
138	138	that tools which only simulate in-place file modification, but do
139	139

	--- www/wsl_caveats.wiki
	+++ www/wsl_caveats.wiki
	@@ -2,15 +2,15 @@
2
3	<h2>When These Issues Matter</h2>
4
5	The discussion following is relevant to those who:
6
7	* Are using the Windows Subsystem for Linux (aka "WSL");
8	* Create a Fossil checkout in a directory accessible from WSL and Windows;
9	* Use both Linux Fossil and Windows tools to modify files in a checkout;
10	* Desire to or must preserve execute permissions set for repository files;
11	* and Use Linux Fossil to commit changes made within the checkout.
12
13	Note that these criteria apply conjunctively; if any are not met,
14	then the consequences of the issues below are at worst annoying
15	and otherwise harmless or absent.
16
	@@ -74,65 +74,65 @@
74
75	<h2>Problematic Usage Scenarios</h2>
76
77	<h3>A Simple Example</h3>
78
79	* Open a checkout in Windows (using fossil.exe) from a project
80	whose files have a mixture of executable and non-executable files.
81	Use a checkout directory visible when running under WSL.
82
83	* Navigate to the same directory in a Linux shell on WSL, then
84	run "fossil status".
85
86	* Depending upon /etc/wsl.conf content (or defaults in its absence),
87	the status ouput will tag checkout files as EXECUTABLE or NOEXEC.
88
89	<h3>Continuation of Simple Example</h3>
90
91	* In the same checkout as above "Simple Example", on WSL,
92	run "fossil revert" to correct all those errant X-bit values.
93
94	* Run "fossil status" again in WSL to verify absence of toggled X-bits.
95
96	* Run "ls -l" from WSL to find two files, one with its X-bit set
97	and the other with it clear.
98
99	* From Windows, perform these steps on each of those files:
100	(1) read the_file content into a buffer<br>
101	(2) rename the_file the_file.bak<br>
102	(3) write buffer content to new file, the_file<br>
103	(4) del the_file.bak (or leave it)<br>
104	(Note that this sequence is similar to what many editors do when
105	a user modifies a file then uses undo to reverse the changes.)
106
107	* Run "fossil status" again in WSL and observe that one of the
108	two files has had its X-bit toggled.
109
110	<h3>A Fossil-Only Example</h3>
111
112	* In the another (different) checkout of the same version,
113	somehow cause "legitimate" X-bit toggles of two files whose
114	X-bits differ. (This "somehow" probably will involve WSL to
115	toggle file bits and fossil on WSL to commit the toggles.)
116
117	* In the Simple Example checkout, use fossil.exe on Windows
118	to update the checkout, ostensibly bringing the X-bit toggles
119	into the affected checkout files.
120
121	* In the Simple Example checkout, use fossil on WSL to run
122	"fossil status", and observe at least one X-bit discrepancy.
123
124	<h2>Recommended Workflow</h2>
125
126	There are two simple approaches for dealing with this issue when
127	one wishes to continue using the same checkout directory from
128	Windows and WSL. Either one is effective. These are:
129
130	* Do not use fossil on WSL for any operations which will modify
131	the repository. Instead, block those operations in some manner.
132
133	* Do not use any tools on Windows, (including certain subcommands
134	of fossil.exe,) which may modify the X-bits on files within the
135	shared checkout, instead restricting use of Windows tools to those
136	which are known to only (and actually) modify file content in place
137	while preserving X-bit values. (The "actually" proviso emphasizes
138	that tools which only simulate in-place file modification, but do
139

	--- www/wsl_caveats.wiki
	+++ www/wsl_caveats.wiki
	@@ -2,15 +2,15 @@
2
3	<h2>When These Issues Matter</h2>
4
5	The discussion following is relevant to those who:
6
7	* Are using the Windows Subsystem for Linux (aka "WSL");
8	* Create a Fossil checkout in a directory accessible from WSL and Windows;
9	* Use both Linux Fossil and Windows tools to modify files in a checkout;
10	* Desire to or must preserve execute permissions set for repository files;
11	* and Use Linux Fossil to commit changes made within the checkout.
12
13	Note that these criteria apply conjunctively; if any are not met,
14	then the consequences of the issues below are at worst annoying
15	and otherwise harmless or absent.
16
	@@ -74,65 +74,65 @@
74
75	<h2>Problematic Usage Scenarios</h2>
76
77	<h3>A Simple Example</h3>
78
79	* Open a checkout in Windows (using fossil.exe) from a project
80	whose files have a mixture of executable and non-executable files.
81	Use a checkout directory visible when running under WSL.
82
83	* Navigate to the same directory in a Linux shell on WSL, then
84	run "fossil status".
85
86	* Depending upon /etc/wsl.conf content (or defaults in its absence),
87	the status ouput will tag checkout files as EXECUTABLE or NOEXEC.
88
89	<h3>Continuation of Simple Example</h3>
90
91	* In the same checkout as above "Simple Example", on WSL,
92	run "fossil revert" to correct all those errant X-bit values.
93
94	* Run "fossil status" again in WSL to verify absence of toggled X-bits.
95
96	* Run "ls -l" from WSL to find two files, one with its X-bit set
97	and the other with it clear.
98
99	* From Windows, perform these steps on each of those files:<br>
100	(1) read the_file content into a buffer<br>
101	(2) rename the_file the_file.bak<br>
102	(3) write buffer content to new file, the_file<br>
103	(4) del the_file.bak (or leave it)<br>
104	(Note that this sequence is similar to what many editors do when
105	a user modifies a file then uses undo to reverse the changes.)
106
107	* Run "fossil status" again in WSL and observe that one of the
108	two files has had its X-bit toggled.
109
110	<h3>A Fossil-Only Example</h3>
111
112	* In the another (different) checkout of the same version,
113	somehow cause "legitimate" X-bit toggles of two files whose
114	X-bits differ. (This "somehow" probably will involve WSL to
115	toggle file bits and fossil on WSL to commit the toggles.)
116
117	* In the Simple Example checkout, use fossil.exe on Windows
118	to update the checkout, ostensibly bringing the X-bit toggles
119	into the affected checkout files.
120
121	* In the Simple Example checkout, use fossil on WSL to run
122	"fossil status", and observe at least one X-bit discrepancy.
123
124	<h2>Recommended Workflow</h2>
125
126	There are two simple approaches for dealing with this issue when
127	one wishes to continue using the same checkout directory from
128	Windows and WSL. Either one is effective. These are:
129
130	* Do not use fossil on WSL for any operations which will modify
131	the repository. Instead, block those operations in some manner.
132
133	* Do not use any tools on Windows, (including certain subcommands
134	of fossil.exe,) which may modify the X-bits on files within the
135	shared checkout, instead restricting use of Windows tools to those
136	which are known to only (and actually) modify file content in place
137	while preserving X-bit values. (The "actually" proviso emphasizes
138	that tools which only simulate in-place file modification, but do
139

Fossil SCM

Keyboard Shortcuts