diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd0eafbfe7..e7c743ef99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ https://gem5-review.googlesource.com/. This documents describes the details of how to create code changes, upload your changes, have your changes reviewed, and finally push your changes to gem5. More information can be found from the following sources: - * http://gem5.org/Submitting_Contributions + * http://gem5.org/contributing * https://gerrit-review.googlesource.com/Documentation/index.html * https://git-scm.com/book @@ -370,8 +370,9 @@ below. the patch can be merged. The patch will receive a +1 if gem5 builds and runs, and it will receive a +2 if the stats match. * Style-Check: This is automatically generated and tests the patch against the - gem5 code style (http://www.gem5.org/Coding_Style). The patch must receive a - +1 from the style checker to be pushed. + gem5 code style + (http://www.gem5.org/documentation/general_docs/development/coding_style/). + The patch must receive a +1 from the style checker to be pushed. Note: Whenever the patch creator updates the patch all reviewers must re-review the patch. There is no longer a "Fix it, then Ship It" option. diff --git a/README b/README index 5b0452bd32..44a97ba940 100644 --- a/README +++ b/README @@ -2,26 +2,23 @@ This is the gem5 simulator. The main website can be found at http://www.gem5.org -A good starting point is http://www.gem5.org/Introduction, and for +A good starting point is http://www.gem5.org/about, and for more information about building the simulator and getting started -please see http://www.gem5.org/Documentation and -http://www.gem5.org/Tutorials. +please see http://www.gem5.org/documentation and +http://www.gem5.org/documentation/learning_gem5/introduction. To build gem5, you will need the following software: g++ or clang, Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4, and lastly protobuf if you want trace capture and playback -support. Please see http://www.gem5.org/Dependencies for more details -concerning the minimum versions of the aforementioned tools. +support. Please see http://www.gem5.org/documentation/general_docs/building +for more details concerning the minimum versions of the aforementioned tools. Once you have all dependencies resolved, type 'scons build//gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS, POWER, SPARC, or X86. This will build an optimized version of the gem5 binary (gem5.opt) for the the specified architecture. See -http://www.gem5.org/Build_System for more details and options. - -With the simulator built, have a look at -http://www.gem5.org/Running_gem5 for more information on how to use -gem5. +http://www.gem5.org/documentation/general_docs/building for more details and +options. The basic source release includes these subdirectories: - configs: example simulation configuration scripts @@ -33,8 +30,7 @@ The basic source release includes these subdirectories: To run full-system simulations, you will need compiled system firmware (console and PALcode for Alpha), kernel binaries and one or more disk -images. Please see the gem5 download page for these items at -http://www.gem5.org/Download +images. If you have questions, please send mail to gem5-users@gem5.org diff --git a/configs/learning_gem5/README b/configs/learning_gem5/README index 64c479ec04..277c384f04 100644 --- a/configs/learning_gem5/README +++ b/configs/learning_gem5/README @@ -8,7 +8,7 @@ only and should not be used for architectural research as-is. "Learning gem5" is a work-in-progress book that is frequently updated. For the most up-to-date version of the book, see the website. -http://learning.gem5.org/book/ +http://gem5.org/documentation/learning_gem5/introduction This directory is broken into one subdirectory per part of the book. diff --git a/configs/learning_gem5/part3/msi_caches.py b/configs/learning_gem5/part3/msi_caches.py index 42ec95a9fc..75f0dce297 100644 --- a/configs/learning_gem5/part3/msi_caches.py +++ b/configs/learning_gem5/part3/msi_caches.py @@ -29,7 +29,8 @@ """ This file creates a set of Ruby caches, the Ruby network, and a simple point-to-point topology. -See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3 +See Part 3 in the Learning gem5 book: +http://gem5.org/documentation/learning_gem5/part3/MSIintro IMPORTANT: If you modify this file, it's likely that the Learning gem5 book also needs to be updated. For now, email Jason diff --git a/configs/learning_gem5/part3/ruby_caches_MI_example.py b/configs/learning_gem5/part3/ruby_caches_MI_example.py index db39bace77..df51801f30 100644 --- a/configs/learning_gem5/part3/ruby_caches_MI_example.py +++ b/configs/learning_gem5/part3/ruby_caches_MI_example.py @@ -29,7 +29,8 @@ """ This file creates a set of Ruby caches, the Ruby network, and a simple point-to-point topology. -See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3 +See Part 3 in the Learning gem5 book: +http://gem5.org/Documentation/learning_gem5/part3/MSIintro You can change simple_ruby to import from this file instead of from msi_caches to use the MI_example protocol instead of MSI. diff --git a/configs/learning_gem5/part3/ruby_test.py b/configs/learning_gem5/part3/ruby_test.py index 9b14a7a8f8..952e33a37e 100644 --- a/configs/learning_gem5/part3/ruby_test.py +++ b/configs/learning_gem5/part3/ruby_test.py @@ -28,7 +28,8 @@ # Authors: Jason Lowe-Power """ This file creates a system with Ruby caches and runs the ruby random tester -See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3 +See Part 3 in the Learning gem5 book: +http://gem5.org/documentation/learning_gem5/part3/MSIintro IMPORTANT: If you modify this file, it's likely that the Learning gem5 book also needs to be updated. For now, email Jason diff --git a/configs/learning_gem5/part3/simple_ruby.py b/configs/learning_gem5/part3/simple_ruby.py index 0c622d0709..89ed60c8dd 100644 --- a/configs/learning_gem5/part3/simple_ruby.py +++ b/configs/learning_gem5/part3/simple_ruby.py @@ -31,7 +31,8 @@ simple multi-threaded application with false sharing to stress the Ruby protocol. -See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3 +See Part 3 in the Learning gem5 book: +http://gem5.org/documentation/learning_gem5/part3/MSIintro IMPORTANT: If you modify this file, it's likely that the Learning gem5 book also needs to be updated. For now, email Jason diff --git a/configs/learning_gem5/part3/test_caches.py b/configs/learning_gem5/part3/test_caches.py index 6495dc558a..9df350b243 100644 --- a/configs/learning_gem5/part3/test_caches.py +++ b/configs/learning_gem5/part3/test_caches.py @@ -29,7 +29,8 @@ """ This file creates a set of Ruby caches, the Ruby network, and a simple point-to-point topology for the RubyRandomTester to use. -See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3 +See Part 3 in the Learning gem5 book: +http://gem5.org/documentation/learning_gem5/part3/MSIintro IMPORTANT: If you modify this file, it's likely that the Learning gem5 book also needs to be updated. For now, email Jason diff --git a/ext/systemc/README.gem5.md b/ext/systemc/README.gem5.md index b966b7d656..63415dff1f 100644 --- a/ext/systemc/README.gem5.md +++ b/ext/systemc/README.gem5.md @@ -16,6 +16,6 @@ protocol-checker from Doulos [[4]][doulos]. [sysc]: http://accellera.org/downloads/standards/systemc -[gem5]: http://www.gem5.org/Main_Page +[gem5]: http://www.gem5.org/ [doulos]: https://www.doulos.com/knowhow/systemc/tlm2/base_protocol_checker/ [strip]: https://github.com/tud-ccc/systemc-scons/commit/913a7451939dc4d4bd752df7081064f9f870517a diff --git a/ext/systemc/README.md b/ext/systemc/README.md index d4b0845914..d8b87c0a87 100644 --- a/ext/systemc/README.md +++ b/ext/systemc/README.md @@ -39,5 +39,5 @@ env.Program('example', ['example.cc', systemc]) ``` [sysc]: http://accellera.org/downloads/standards/systemc -[gem5]: http://www.gem5.org/Main_Page +[gem5]: http://www.gem5.org/ [doulos]: https://www.doulos.com/knowhow/systemc/tlm2/base_protocol_checker/ diff --git a/site_scons/site_init.py b/site_scons/site_init.py index 623e26e0a6..82e1c8a4de 100644 --- a/site_scons/site_init.py +++ b/site_scons/site_init.py @@ -52,7 +52,7 @@ try: except SystemExit as e: print(""" For more details, see: - http://gem5.org/Dependencies + http://gem5.org/documentation/general_docs/building """) raise @@ -64,9 +64,6 @@ except SystemExit as e: You can use a non-default installation of the Python interpreter by rearranging your PATH so that scons finds the non-default 'python' and 'python-config' first. - -For more details, see: - http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation """) raise diff --git a/util/streamline/m5stats2streamline.py b/util/streamline/m5stats2streamline.py index 98aa1a861f..eef3f8053a 100755 --- a/util/streamline/m5stats2streamline.py +++ b/util/streamline/m5stats2streamline.py @@ -41,7 +41,6 @@ # This script converts gem5 output to ARM DS-5 Streamline .apc project file # (Requires the gem5 runs to be run with ContextSwitchStatsDump enabled and # some patches applied to target Linux kernel.) -# Visit http://www.gem5.org/Streamline for more details. # # Usage: # m5stats2streamline.py @@ -76,8 +75,6 @@ parser = argparse.ArgumentParser( (NOTE: Requires gem5 runs to be run with ContextSwitchStatsDump enabled and some patches applied to the target Linux kernel.) - Visit http://www.gem5.org/Streamline for more details. - APC project generation based on Gator v17 (DS-5 v5.17) Subsequent versions should be backward compatible """) diff --git a/util/tlm/README b/util/tlm/README index 69fda0b892..9a2d57bc7d 100644 --- a/util/tlm/README +++ b/util/tlm/README @@ -172,7 +172,7 @@ VI. Elastic Trace Setup Elastic traces can also be replayed into the SystemC world. For more information on elastic traces please refer to: - - http://www.gem5.org/TraceCPU + - http://www.gem5.org/documentation/general_docs/cpu_models/TraceCPU - Exploring System Performance using Elastic Traces: Fast, Accurate and Portable diff --git a/util/vi/vimrc b/util/vi/vimrc index b8cf4d6357..29d1819036 100644 --- a/util/vi/vimrc +++ b/util/vi/vimrc @@ -37,7 +37,7 @@ " this vimrc file helps users follow the gem5 style guide see: -" www.gem5.org/Coding_Style +" www.gem5.org/documentation/general_docs/development/coding_style " it highlights extraneaous whitespace and tabs (so you can easily remove " them), sets column length to a max of 78 characters, expands tabs, and sets " a tab width of 4 spaces.