go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/mmutex/README.md (about)

     1  Maintenance Mutex (mmutex)
     2  ==========================
     3  
     4  mmutex is a command line tool that helps prevent maintenance tasks from running
     5  during user tasks. The tool does this by way of a global lock file that users 
     6  must acquire before running their tasks.
     7  
     8  Clients can use this tool to request that their task be run with one of two 
     9  types of access to the system:
    10  
    11    * **Exclusive access** guarantees that no other callers have any access
    12      exclusive or shared) to the resource while the specified command is run.
    13    * **Shared access** guarantees that only other callers with shared access
    14      will have access to the resource while the specified command is run.
    15  
    16  In short, exclusive access guarantees a task is run alone, while shared access
    17  tasks may be run alongside other shared access tasks.
    18  
    19  TODO(charliea): Document actual command line usage here.