restructure manager section

This commit is contained in:
Sagar Karandikar 2018-05-20 00:02:46 +00:00
parent 4f4db56681
commit d4bc5933dc
5 changed files with 58 additions and 16 deletions

View File

@ -0,0 +1,13 @@
Manager Command Line Arguments
========================
The manager provides built-in help output if you run ``firesim --help``
.. include:: HELP_OUTPUT
:code: ini
In the following sections, we outline the individual commands that the manager
supports.

View File

@ -0,0 +1,30 @@
Overview
========================
When you source ``sourceme-f1-manager.sh`` in your copy of the firesim repo,
you get access to a new command, ``firesim``, which is the FireSim simulation
manager. If you've used tools like Vagrant or Docker, the ``firesim`` program
is to FireSim what ``vagrant`` and ``docker`` are to Vagrant and Docker
respectively. In essence, ``firesim`` lets us manage the entire lifecycle
of FPGA simulations, just like ``vagrant`` and ``docker`` do for VMs and
containers respectively.
"Inputs"
--------------
The manager gets configuration information from several places:
- Command Line Arguments, consisting of:
- Configuration files to use
- A task to run
- Arguments to the task
- Configuration Files
- ``user_topology.py``
The following sections detail these inputs. Hit Next to continue.

View File

@ -1,18 +1,7 @@
Manager Commands
Manager Tasks
========================
This page contains a centralized reference for all of the manager commands.
Overview
----------------
When you source ``sourceme-f1-manager.sh`` in your copy of the firesim repo,
you get access to a new command, ``firesim``, which is the manager.
The manager provides built-in help output if you run ``firesim --help``
.. include:: HELP_OUTPUT
:code: ini
This page contains a centralized reference for all of the manager tasks.
In the following sections, we outline the individual commands that the manager
supports.
@ -23,7 +12,10 @@ supports.
``firesim managerinit``
----------------------------
This is a setup command that does the following:
* Run ``aws configure``, prompt for credentials
* Backup existing default config files if the user has them

View File

@ -0,0 +1,4 @@
Manager Topology Definitions (``user_topology.py``)
========================
TODO

View File

@ -1,4 +1,4 @@
Manager Details
Manager Details (``firesim``)
================
This section contains detailed information about manager commands and configuration
@ -7,10 +7,13 @@ options.
.. toctree::
:maxdepth: 2
:caption: Manager:
:caption: Manager Details:
:numbered:
Manager-Overview
Manager-Command-Line-Args
Manager-Tasks
Manager-Configuration-Files
Manager-Commands
Manager-Topology-Definitions
AGFI-Tagging