- 
                Notifications
    You must be signed in to change notification settings 
- Fork 263
btrfs-progs: docs: further improve space cache documentation #620
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Open
      
      
            calestyo
  wants to merge
  2
  commits into
  kdave:devel
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
calestyo:further-improve-space-cache-documentation
  
      
      
   
  
    
  
  
  
 
  
      
    base: devel
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
                
     Open
            
            btrfs-progs: docs: further improve space cache documentation #620
                    calestyo
  wants to merge
  2
  commits into
  kdave:devel
from
calestyo:further-improve-space-cache-documentation
  
      
      
   
              
            
      
        
          +29
        
        
          −23
        
        
          
        
      
    
  
Conversation
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
    - For the btrfs check option of clearing, indicate that - since it's actually a full removing - a new space cache may be generated on the next mount. - In the summary of the `clear_cache` mount option, don't mention that it rebuilds the cache, as the option itself is in principle only about the clearing and the rebuilding happens "automatically" (unless other options are used). - In the details mention, however that there is rebuilding unless prevented by mount option. - Remove the "if something has gone wrong", as the mount option would also remove the cache if nothing went wrong. Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
| please wait with this one... there's more to come | 
Strcturise the details more clearly by: - What it does/implications. - The different versions an their details. - What happens if both versions are present. - What happens with kernels that cannot use v2. - How each version can be disabled, cleared or removed. - Make it more clear that the default of "space cache v2" applies also if the option isn't given at all. Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
e94afc8    to
    e8a471c      
    Compare
  
    | Correctly rebased on  
 Is the old v1 then cleared or (as with  | 
af681f4    to
    1628b2f      
    Compare
  
    a8c6f08    to
    34c5de3      
    Compare
  
    5e02de0    to
    adfc8a9      
    Compare
  
    d21d383    to
    77988fe      
    Compare
  
    ff87660    to
    89204e7      
    Compare
  
    869b77c    to
    76f0670      
    Compare
  
    ef43ce6    to
    3eff852      
    Compare
  
    dafafca    to
    5d47f58      
    Compare
  
    bb6a159    to
    0fb0189      
    Compare
  
    0ad9c81    to
    9c1d53d      
    Compare
  
    5d51853    to
    6ea7070      
    Compare
  
    9551363    to
    94c16d5      
    Compare
  
    d82be5c    to
    25f665e      
    Compare
  
    
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment
  
      
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
For the btrfs check option of clearing, indicate that - since it's actually a full removing - a new space cache may be generated on the next mount.
In the summary of the
clear_cachemount option, don't mention that it rebuilds the cache, as the option itself is in principle only about the clearing and the rebuilding happens "automatically" (unless other options are used).In the details mention, however that there is rebuilding unless prevented by mount option.
Remove the "if something has gone wrong", as the mount option would also remove the cache if nothing went wrong.