Fossil SCM

Added a new glossary item "Capabilities" to introduce the term and distinguish it from "Permissions", and made several changes to the referenced document to reinforce this distinction and explain why we bother to make it.

wyoung 2023-03-13 19:00 trunk
Commit 23b91f3794581299f03deb39aaf9b81765d494a7d62147d4be8a44a80e18b06f
Parent 2eef3acda352c7f…
4 files changed +8 -4 +15 +1 -1 +1 -1
~ www/caps/index.md ~ www/glossary.md ~ www/mkindex.tcl ~ www/permutedindex.html
M www/caps/index.md
+8 -4
--- www/caps/index.md
+++ www/caps/index.md
@@ -1,11 +1,15 @@
1
-# Administering User Capabilities
1
+# Administering User Capabilities (a.k.a. Permissions)
22
33
 Fossil includes a powerful [role-based access control system][rbac]
4
-which affects which users have which capabilities within a given
5
-[served][svr] Fossil repository. We call this the capability system, or
6
-“caps” for short.
4
+which affects which users have which capabilities(^Some parts of the
5
+Fossil code call these “permissions” instead, but since there is [a
6
+clear and present risk of confusion](#webonly) with operating system
7
+level file permissions in this context, we avoid using that term for
8
+Fossil’s RBAC capability flags in these pages.) within a given
9
+[served][svr] Fossil repository. We call this the “caps” system for
10
+short.
711
812
 Fossil stores a user’s caps as an unordered string of ASCII characters,
913
 one capability per, [currently](./impl.md#choices) limited to
1014
 [alphanumerics][an]. Caps are case-sensitive: “**A**” and “**a**” are
1115
 different user capabilities.
1216
--- www/caps/index.md
+++ www/caps/index.md
@@ -1,11 +1,15 @@
1 # Administering User Capabilities
2
3 Fossil includes a powerful [role-based access control system][rbac]
4 which affects which users have which capabilities within a given
5 [served][svr] Fossil repository. We call this the capability system, or
6 “caps” for short.
 
 
 
 
7
8 Fossil stores a user’s caps as an unordered string of ASCII characters,
9 one capability per, [currently](./impl.md#choices) limited to
10 [alphanumerics][an]. Caps are case-sensitive: “**A**” and “**a**” are
11 different user capabilities.
12
--- www/caps/index.md
+++ www/caps/index.md
@@ -1,11 +1,15 @@
1 # Administering User Capabilities (a.k.a. Permissions)
2
3 Fossil includes a powerful [role-based access control system][rbac]
4 which affects which users have which capabilities(^Some parts of the
5 Fossil code call these “permissions” instead, but since there is [a
6 clear and present risk of confusion](#webonly) with operating system
7 level file permissions in this context, we avoid using that term for
8 Fossil’s RBAC capability flags in these pages.) within a given
9 [served][svr] Fossil repository. We call this the “caps” system for
10 short.
11
12 Fossil stores a user’s caps as an unordered string of ASCII characters,
13 one capability per, [currently](./impl.md#choices) limited to
14 [alphanumerics][an]. Caps are case-sensitive: “**A**” and “**a**” are
15 different user capabilities.
16
M www/glossary.md
+15
--- www/glossary.md
+++ www/glossary.md
@@ -372,6 +372,21 @@
372372
 [fef]: ./fileedit-page.md
373373
 [fshr]: ./selfhost.wiki
374374
 [wiki]: ./wikitheory.wiki
375375
376376
377
+## <a id="caps"></a>Capabilities
378
+
379
+Fossil includes a powerful [role-based access control system][rbac]
380
+which affects which users have which capabilities within a given
381
+[repository](#repo). You can read more about this complex topic
382
+[here](./caps/).
383
+
384
+Some people — and indeed certain parts of Fossil’s own code — use the
385
+term “permissions” instead, but since [operating system file permissions
386
+also play into this](./caps/#webonly), we prefer the term “capabilities”
387
+(or “caps” for short) when talking about Fossil’s RBAC system to avoid a
388
+confusion here.
389
+
390
+[rbac]: https://en.wikipedia.org/wiki/Role-based_access_control
391
+
377392
 <div style="height:50em" id="this-space-intentionally-left-blank"></div>
378393
--- www/glossary.md
+++ www/glossary.md
@@ -372,6 +372,21 @@
372 [fef]: ./fileedit-page.md
373 [fshr]: ./selfhost.wiki
374 [wiki]: ./wikitheory.wiki
375
376
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
377 <div style="height:50em" id="this-space-intentionally-left-blank"></div>
378
--- www/glossary.md
+++ www/glossary.md
@@ -372,6 +372,21 @@
372 [fef]: ./fileedit-page.md
373 [fshr]: ./selfhost.wiki
374 [wiki]: ./wikitheory.wiki
375
376
377 ## <a id="caps"></a>Capabilities
378
379 Fossil includes a powerful [role-based access control system][rbac]
380 which affects which users have which capabilities within a given
381 [repository](#repo). You can read more about this complex topic
382 [here](./caps/).
383
384 Some people — and indeed certain parts of Fossil’s own code — use the
385 term “permissions” instead, but since [operating system file permissions
386 also play into this](./caps/#webonly), we prefer the term “capabilities”
387 (or “caps” for short) when talking about Fossil’s RBAC system to avoid a
388 confusion here.
389
390 [rbac]: https://en.wikipedia.org/wiki/Role-based_access_control
391
392 <div style="height:50em" id="this-space-intentionally-left-blank"></div>
393
M www/mkindex.tcl
+1 -1
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -23,11 +23,11 @@
2323
 blockchain.md {Is Fossil A Blockchain?}
2424
 branching.wiki {Branching, Forking, Merging, and Tagging}
2525
 bugtheory.wiki {Bug Tracking In Fossil}
2626
 build.wiki {Compiling and Installing Fossil}
2727
 cap-theorem.md {Fossil and the CAP Theorem}
28
- caps/ {Administering User Capabilities}
28
+ caps/ {Administering User Capabilities (a.k.a. Permissions)}
2929
 caps/admin-v-setup.md {Differences Between Setup and Admin Users}
3030
 caps/ref.html {User Capability Reference}
3131
 cgi.wiki {CGI Script Configuration Options}
3232
 changes.wiki {Fossil Changelog}
3333
 chat.md {Fossil Chat}
3434
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -23,11 +23,11 @@
23 blockchain.md {Is Fossil A Blockchain?}
24 branching.wiki {Branching, Forking, Merging, and Tagging}
25 bugtheory.wiki {Bug Tracking In Fossil}
26 build.wiki {Compiling and Installing Fossil}
27 cap-theorem.md {Fossil and the CAP Theorem}
28 caps/ {Administering User Capabilities}
29 caps/admin-v-setup.md {Differences Between Setup and Admin Users}
30 caps/ref.html {User Capability Reference}
31 cgi.wiki {CGI Script Configuration Options}
32 changes.wiki {Fossil Changelog}
33 chat.md {Fossil Chat}
34
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -23,11 +23,11 @@
23 blockchain.md {Is Fossil A Blockchain?}
24 branching.wiki {Branching, Forking, Merging, and Tagging}
25 bugtheory.wiki {Bug Tracking In Fossil}
26 build.wiki {Compiling and Installing Fossil}
27 cap-theorem.md {Fossil and the CAP Theorem}
28 caps/ {Administering User Capabilities (a.k.a. Permissions)}
29 caps/admin-v-setup.md {Differences Between Setup and Admin Users}
30 caps/ref.html {User Capability Reference}
31 cgi.wiki {CGI Script Configuration Options}
32 changes.wiki {Fossil Changelog}
33 chat.md {Fossil Chat}
34
M www/permutedindex.html
+1 -1
--- www/permutedindex.html
+++ www/permutedindex.html
@@ -24,11 +24,11 @@
2424
 <h2 id="pindex">Other Documents:</h2>
2525
 <ul>
2626
 <li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation Of Fossil</a></li>
2727
 <li><a href="serverext.wiki">Adding Extensions To A Fossil Server Using CGI Scripts</a></li>
2828
 <li><a href="adding_code.wiki">Adding New Features To Fossil</a></li>
29
-<li><a href="caps/">Administering User Capabilities</a></li>
29
+<li><a href="caps/">Administering User Capabilities (a.k.a. Permissions)</a></li>
3030
 <li><a href="backup.md">Backing Up a Remote Fossil Repository</a></li>
3131
 <li><a href="whyusefossil.wiki">Benefits Of Version Control</a></li>
3232
 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
3333
 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
3434
 <li><a href="cgi.wiki">CGI Script Configuration Options</a></li>
3535
--- www/permutedindex.html
+++ www/permutedindex.html
@@ -24,11 +24,11 @@
24 <h2 id="pindex">Other Documents:</h2>
25 <ul>
26 <li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation Of Fossil</a></li>
27 <li><a href="serverext.wiki">Adding Extensions To A Fossil Server Using CGI Scripts</a></li>
28 <li><a href="adding_code.wiki">Adding New Features To Fossil</a></li>
29 <li><a href="caps/">Administering User Capabilities</a></li>
30 <li><a href="backup.md">Backing Up a Remote Fossil Repository</a></li>
31 <li><a href="whyusefossil.wiki">Benefits Of Version Control</a></li>
32 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
33 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
34 <li><a href="cgi.wiki">CGI Script Configuration Options</a></li>
35
--- www/permutedindex.html
+++ www/permutedindex.html
@@ -24,11 +24,11 @@
24 <h2 id="pindex">Other Documents:</h2>
25 <ul>
26 <li><a href="tech_overview.wiki">A Technical Overview Of The Design And Implementation Of Fossil</a></li>
27 <li><a href="serverext.wiki">Adding Extensions To A Fossil Server Using CGI Scripts</a></li>
28 <li><a href="adding_code.wiki">Adding New Features To Fossil</a></li>
29 <li><a href="caps/">Administering User Capabilities (a.k.a. Permissions)</a></li>
30 <li><a href="backup.md">Backing Up a Remote Fossil Repository</a></li>
31 <li><a href="whyusefossil.wiki">Benefits Of Version Control</a></li>
32 <li><a href="branching.wiki">Branching, Forking, Merging, and Tagging</a></li>
33 <li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
34 <li><a href="cgi.wiki">CGI Script Configuration Options</a></li>
35

Keyboard Shortcuts

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