mirror of
				https://github.com/Telecominfraproject/wlan-lanforge-scripts.git
				synced 2025-10-31 18:58:01 +00:00 
			
		
		
		
	Added docstring for documentation and usage example
This commit is contained in:
		| @@ -1,5 +1,18 @@ | ||||
| #!/usr/bin/env python3 | ||||
|  | ||||
| """ | ||||
|     This script will create a variable number of stations or macvlans to test fileio traffic. Pre-existing stations and | ||||
|     macvlans can be used as well. Command line options are available to update cross-connects as well as using a list of | ||||
|     existing cross-connects if desired. if none are given, cross-connects and endpoints will be created by the script. | ||||
|     Modes such as read-only, write-only, or both can be specified as well as ip addresses and starting numbers for sequential | ||||
|     stations or macvlans that are created in case of limited or pre-existing configurations. The test that is run during | ||||
|     this script will depend on the mode used, a read-only test will check the read-bps column, write-only will check write-bps | ||||
|     and both will check both columns. If the relevant columns increase over the duration of the test it will pass, | ||||
|     otherwise it will fail. | ||||
|  | ||||
|     Use './test_fileio.py --help' to see command line usage and options | ||||
| """ | ||||
|  | ||||
| import sys | ||||
| if sys.version_info[0] != 3: | ||||
|     print("This script requires Python 3") | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Logan Lipke
					Logan Lipke