mirror of
				https://github.com/ARM-software/workload-automation.git
				synced 2025-10-31 15:12:25 +00:00 
			
		
		
		
	workloads/chrome: fix docs
- Escape asterisk (otherwise, it is interpreted as "open emphasis") - Use monospace formatting for paths. - Trim to 79 columns wide
This commit is contained in:
		
				
					committed by
					
						 Marc Bonnici
						Marc Bonnici
					
				
			
			
				
	
			
			
			
						parent
						
							b85665fa12
						
					
				
				
					commit
					35f644ba76
				
			| @@ -5,26 +5,30 @@ class Chrome(ApkUiautoWorkload): | |||||||
|  |  | ||||||
|     name = 'chrome' |     name = 'chrome' | ||||||
|     description = ''' |     description = ''' | ||||||
|     A workload to perform standard Web browsing tasks with Google Chrome. The workload carries |     A workload to perform standard Web browsing tasks with Google Chrome. The | ||||||
|     out a number of typical Web-based tasks, navigating through a handful of Wikipedia pages |     workload carries out a number of typical Web-based tasks, navigating through | ||||||
|     in multiple browser tabs. |     a handful of Wikipedia pages in multiple browser tabs. | ||||||
|  |  | ||||||
|     To run the workload in offline mode, a 'pages.tar' archive and an 'OfflinePages.db' file |     To run the workload in offline mode, a ``pages.tar`` archive and an | ||||||
|     are required. For users wishing to generate these files themselves, Chrome should first be |     ``OfflinePages.db`` file are required. For users wishing to generate these | ||||||
|     operated from an Internet-connected environment and the following Wikipedia pages should be |     files themselves, Chrome should first be operated from an Internet-connected | ||||||
|     downloaded for offline use within Chrome: |     environment and the following Wikipedia pages should be downloaded for | ||||||
|  |     offline use within Chrome: | ||||||
|  |  | ||||||
|     - https://en.m.wikipedia.org/wiki/Main_Page |     - https://en.m.wikipedia.org/wiki/Main_Page | ||||||
|     - https://en.m.wikipedia.org/wiki/United_States |     - https://en.m.wikipedia.org/wiki/United_States | ||||||
|     - https://en.m.wikipedia.org/wiki/California |     - https://en.m.wikipedia.org/wiki/California | ||||||
|  |  | ||||||
|     Following this, the files of interest for viewing these pages offline can be found in the |     Following this, the files of interest for viewing these pages offline can be | ||||||
|     '/data/data/com.android.chrome/app_chrome/Default/Offline Pages' directory. The 'OfflinePages.db' |     found in the ``/data/data/com.android.chrome/app_chrome/Default/Offline | ||||||
|     file can be copied from the 'metadata' subdirectory, while the ``*.mhtml`` files that should make |     Pages`` directory. The ``OfflinePages.db`` file can be copied from the | ||||||
|     up the 'pages.tar' file can be found in the 'archives' subdirectory. These page files can then be |     'metadata' subdirectory, while the ``*.mhtml`` files that should make up the | ||||||
|     archived to produce a tarball using a command such as ``tar -cvf pages.tar -C /path/to/archives .``. |     ``pages.tar`` file can be found in the 'archives' subdirectory. These page | ||||||
|     Both this and 'OfflinePages.db' should then be placed in the '~/.workload_automation/dependencies/chrome/' |     files can then be archived to produce a tarball using a command such as | ||||||
|     directory on your local machine, creating this if it does not already exist. |     ``tar -cvf pages.tar -C /path/to/archives .``.  Both this and | ||||||
|  |     ``OfflinePages.db`` should then be placed in the | ||||||
|  |     ``~/.workload_automation/dependencies/chrome/`` directory on your local | ||||||
|  |     machine, creating this if it does not already exist. | ||||||
|  |  | ||||||
|     Known working APK version: 65.0.3325.109 |     Known working APK version: 65.0.3325.109 | ||||||
|     ''' |     ''' | ||||||
| @@ -33,11 +37,11 @@ class Chrome(ApkUiautoWorkload): | |||||||
|     parameters = [ |     parameters = [ | ||||||
|         Parameter('offline_mode', kind=bool, default=False, description=''' |         Parameter('offline_mode', kind=bool, default=False, description=''' | ||||||
|                   If set to ``True``, the workload will execute in offline mode. |                   If set to ``True``, the workload will execute in offline mode. | ||||||
|                   This mode requires root and makes use of a tarball of *.mhtml |                   This mode requires root and makes use of a tarball of \*.mhtml | ||||||
|                   files 'pages.tar' and an metadata database 'OfflinePages.db'. |                   files 'pages.tar' and an metadata database 'OfflinePages.db'. | ||||||
|                   The tarball is extracted directly to the application's offline |                   The tarball is extracted directly to the application's offline | ||||||
|                   pages 'archives' directory, while the database is copied to the |                   pages 'archives' directory, while the database is copied to | ||||||
|                   offline pages 'metadata' directory. |                   the offline pages 'metadata' directory. | ||||||
|                   '''), |                   '''), | ||||||
|     ] |     ] | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user