Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(576)

Unified Diff: mmutex/README.md

Issue 2974113002: Create a maintenance mutex skeleton within luci-go (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | mmutex/cmd/mmutex/main.go » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: mmutex/README.md
diff --git a/mmutex/README.md b/mmutex/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..3f295a4772ce816082eeb473e86b0ac0709899b8
--- /dev/null
+++ b/mmutex/README.md
@@ -0,0 +1,19 @@
+Maintenance Mutex (mmutex)
+==========================
+
+mmutex is a command line tool that helps prevent maintenance tasks from running
+during user tasks. The tool does this by way of a global lock file that users
+must acquire before running their tasks.
+
+Clients can use this tool to request that their task be run with one of two
+types of access to the system:
+
+ * **Exclusive access** guarantees that no other callers have any access
+ exclusive or shared) to the resource while the specified command is run.
+ * **Shared access** guarantees that only other callers with shared access
+ will have access to the resource while the specified command is run.
+
+In short, exclusive access guarantees a task is run alone, while shared access
+tasks may be run alongside other shared access tasks.
+
+TODO(charliea): Document actual command line usage here.
« no previous file with comments | « no previous file | mmutex/cmd/mmutex/main.go » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698