website: fixed broken links, typos, formatting
Change-Id: Iddbf3333e96a85b6701f92b613fb6b2a369751d3
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-website/+/31115
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: Jason Lowe-Power <power.jg@gmail.com>
diff --git a/_pages/documentation/learning_gem5/introduction.md b/_pages/documentation/learning_gem5/introduction.md
index 58d5aa9..ea2b013 100644
--- a/_pages/documentation/learning_gem5/introduction.md
+++ b/_pages/documentation/learning_gem5/introduction.md
@@ -30,13 +30,7 @@
tools like gem5, it is important to actually understand how it works
before using it.
-Finish the previous paragraph about how it is a good idea to understand
-what your tools are actually doing.
-
-should add a list of terms. Things like "simulated system" vs "host
-system", etc.
-
-You can find the source for this book on our at
+You can find the source for this book at
<https://gem5.googlesource.com/public/gem5-website/+/refs/heads/master/_pages/documentation/learning_gem5/>.
## What is gem5?
diff --git a/_pages/documentation/learning_gem5/part1/building.md b/_pages/documentation/learning_gem5/part1/building.md
index df8ad35..8b1dbcc 100644
--- a/_pages/documentation/learning_gem5/part1/building.md
+++ b/_pages/documentation/learning_gem5/part1/building.md
@@ -16,8 +16,7 @@
Requirements for gem5
---------------------
-See [gem5 requirements](http://gem5.org/Compiling_M5#Required_Software)
-for more details.
+See [gem5 requirements](http://www.gem5.org/documentation/general_docs/building#dependencies) for more details.
On Ubuntu, you can install all of the required dependencies with the
following command. The requirements are detailed below.
@@ -251,10 +250,7 @@
To fix this, you can force SCons to use your environment's Python
version by running `` python `which scons` build/X86/gem5.opt `` instead
-of `scons build/X86/gem5.opt`. More information on this can be found on
-the gem5 wiki about non-default Python locations: [Using a non-default
-Python
-installation](http://www.gem5.org/Using_a_non-default_Python_installation).
+of `scons build/X86/gem5.opt`.
### M4 macro processor not installed
diff --git a/_pages/documentation/learning_gem5/part1/cache_config.md b/_pages/documentation/learning_gem5/part1/cache_config.md
index e9dfb66..8f51044 100644
--- a/_pages/documentation/learning_gem5/part1/cache_config.md
+++ b/_pages/documentation/learning_gem5/part1/cache_config.md
@@ -11,7 +11,7 @@
Adding cache to the configuration script
========================================
-Using the [previous configuration script as a starting point](/simple_config),
+Using the [previous configuration script as a starting point](http://www.gem5.org/documentation/learning_gem5/part1/simple_config/),
this chapter will walk through a more complex configuration. We will add
a cache hierarchy to the system as shown in
the figure below. Additionally, this chapter
@@ -182,11 +182,11 @@
The full file can be found in the gem5 source at
`gem5/configs/learning_gem5/part1/caches.py`.
-Adding caches the simple config file
+Adding caches to the simple config file
------------------------------------
Now, let's add the caches we just created to the configuration script we
-created in the last chapter \<simple-config-chapter\>.
+created in the [last chapter]((http://www.gem5.org/documentation/learning_gem5/part1/simple_config/).
First, let's copy the script to a new name.
@@ -217,9 +217,8 @@
system.cpu.dcache.connectCPU(system.cpu)
```
-You need to *remove* the lines which connected the cache
-ports directly to the memory bus, replaying them with
-the following two lines.
+You need to *remove* the following two lines which connected the cache
+ports directly to the memory bus.
```
system.cpu.icache_port = system.membus.slave
diff --git a/_pages/documentation/learning_gem5/part1/gem5_stats.md b/_pages/documentation/learning_gem5/part1/gem5_stats.md
index 165254c..b59aa15 100644
--- a/_pages/documentation/learning_gem5/part1/gem5_stats.md
+++ b/_pages/documentation/learning_gem5/part1/gem5_stats.md
@@ -26,8 +26,6 @@
: A text representation of all of the gem5 statistics registered for
the simulation.
-Where these files are created can be controlled by
-
config.ini
----------
@@ -142,17 +140,16 @@
sim_insts 5712 # Number of instructions simulated
sim_ops 10314 # Number of ops (including micro ops) simulated
----------- Begin Simulation Statistics ----------sim\_seconds 0.000508
-\# Number of seconds simulated sim\_ticks 507841000 \# Number of ticks
-simulated final\_tick 507841000 \# Number of ticks from beginning of
-simulation (restored from checkpoints and never reset) sim\_freq
-1000000000000 \# Frequency of simulated ticks host\_inst\_rate 157744 \#
-Simulator instruction rate (inst/s) host\_op\_rate 284736 \# Simulator
-op (including micro ops) rate (op/s) host\_tick\_rate 14017997125 \#
-Simulator tick rate (ticks/s) host\_mem\_usage 642808 \# Number of bytes
-of host memory used host\_seconds 0.04 \# Real time elapsed on the host
-sim\_insts 5712 \# Number of instructions simulated sim\_ops 10313 \#
-Number of ops (including micro ops) simulated
+ ---------- Begin Simulation Statistics ----------
+ sim_seconds 0.000508 # Number of seconds simulated
+ sim_ticks 507841000 # Number of ticks simulated
+ final_tick 507841000 # Number of ticks from beginning of simulation (restored from checkpoints and never reset)
+ sim_freq 1000000000000 # Frequency of simulated ticks
+ host_inst_rate 157744 # Simulator instruction rate (inst/s) host_op_rate 284736 # Simulator op (including micro ops) rate (op/s)
+ host_tick_rate 14017997125 # Simulator tick rate (ticks/s)
+ host_mem_usage 642808 # Number of bytes of host memory used host_seconds 0.04 # Real time elapsed on the host
+ sim_insts 5712 # Number of instructions simulated
+ sim_ops 10313 # Number of ops (including micro ops) simulated
The statistic dump begins with
`---------- Begin Simulation Statistics ----------`. There may be
diff --git a/_pages/documentation/learning_gem5/part1/simple_config.md b/_pages/documentation/learning_gem5/part1/simple_config.md
index 5187e2d..3bd3133 100644
--- a/_pages/documentation/learning_gem5/part1/simple_config.md
+++ b/_pages/documentation/learning_gem5/part1/simple_config.md
@@ -53,7 +53,7 @@
> configuration script you can create any SimObject, set its parameters,
> and specify the interactions between SimObjects.
>
-> See <http://www.gem5.org/SimObjects> for more information.
+> See [SimObject details](http://doxygen.gem5.org/release/current/classSimObject.html#details) for more information.
Creating a config file
----------------------
@@ -168,8 +168,7 @@
> behind the scenes to set up the connection, the details of which are
> unimportant for most users.
>
-> We will discuss ports and MemObject in more detail in
-> memoryobject-chapter.
+> We will discuss ports and MemObject in more detail in the [MemObject chapter](http://www.gem5.org/documentation/learning_gem5/part2/memoryobject/).
Next, we need to connect up a few other ports to make sure that our
system will function correctly. We need to create an I/O controller on
@@ -201,7 +200,7 @@
```
After those final connections, we've finished instantiating our
-simulated system! Our system should look like simple-config-fig.
+simulated system! Our system should look like the figure below.
