test: improve docs for when using HEAD or similar flags
Closes Homebrew/homebrew#29791. Signed-off-by: Adam Vandenberg <flangy@gmail.com>
This commit is contained in:
		
							parent
							
								
									68f27922bc
								
							
						
					
					
						commit
						bd05334487
					
				@ -334,7 +334,8 @@ Note that these flags should only appear after a command.
 | 
			
		||||
    A few formulae provide a test method. `brew test <formula>` runs this
 | 
			
		||||
    test method. There is no standard output or return code, but it should
 | 
			
		||||
    generally indicate to the user if something is wrong with the installed
 | 
			
		||||
    formula.
 | 
			
		||||
    formula. Options passed to `brew install` such as `--HEAD` also need to
 | 
			
		||||
    be provided to `brew test`.
 | 
			
		||||
 | 
			
		||||
    Example: `brew install jruby && brew test jruby`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -165,7 +165,8 @@ class FormulaCreator
 | 
			
		||||
        #
 | 
			
		||||
        # This test will fail and we won't accept that! It's enough to just replace
 | 
			
		||||
        # "false" with the main program this formula installs, but it'd be nice if you
 | 
			
		||||
        # were more thorough. Run the test with `brew test #{name}`.
 | 
			
		||||
        # were more thorough. Run the test with `brew test #{name}`. Options passed
 | 
			
		||||
        # to `brew install` such as `--HEAD` also need to be provided to `brew test`.
 | 
			
		||||
        #
 | 
			
		||||
        # The installed folder is not in the path, so use the entire path to any
 | 
			
		||||
        # executables being tested: `system "\#{bin}/program", "do", "something"`.
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user