title: Documentation

docs:
  - title: gem5 documentation
    items:
    - title: gem5 documentation
      id: gem5_documentation
      url: /documentation

    - title: Code Style
      id: code_style
      url: /documentation/general_docs/development/coding_style/

    - title: Building
      id: building
      subitems:
        - page: Building
          url: /documentation/general_docs/building
        - page: Building EXTRAS
          url: /documentation/general_docs/building/EXTRAS

    - title: Full System
      id: fullsystem
      subitems:
        - page: Creating Disk Images
          url: /documentation/general_docs/fullsystem/disks
        - page: Devices
          url: /documentation/general_docs/fullsystem/devices
        - page: m5term
          url: /documentation/general_docs/fullsystem/m5term

    - title: Memory System
      id: memory_system
      subitems:
        - page: Memory System
          url: /documentation/general_docs/memory_system/

        - page: gem5 Memory System
          url: /documentation/general_docs/memory_system/gem5_memory_system

        - page: Replacement Policies
          url: /documentation/general_docs/memory_system/replacement_policies

        - page: Indexing Policies
          url: /documentation/general_docs/memory_system/indexing_policies

        - page: Classic memory system coherence
          url: /documentation/general_docs/memory_system/classic-coherence-protocol

        - page: Classic caches
          url: /documentation/general_docs/memory_system/classic_caches

    - title: Ruby Memory System
      id: ruby
      subitems:
        - page: Ruby
          url: /documentation/general_docs/ruby
        - page: Cache Coherence Protocols
          url: /documentation/general_docs/ruby/cache-coherence-protocols
        - page: Garnet 2.0
          url: /documentation/general_docs/ruby/garnet-2
        - page: MOESI CMP directory
          url: /documentation/general_docs/ruby/MOESI_CMP_directory
        - page: Garnet Synthetic Traffic
          url: /documentation/general_docs/ruby/garnet_synthetic_traffic
        - page: SLICC
          url: /documentation/general_docs/ruby/slicc
        - page: MI example
          url: /documentation/general_docs/ruby/MI_example
        - page: Garnet standalone
          url: /documentation/general_docs/ruby/Garnet_standalone
        - page: Interconnection network
          url: /documentation/general_docs/ruby/interconnection-network
        - page: MOESI hammer
          url: /documentation/general_docs/ruby/MOESI_hammer
        - page: MOESI CMP token
          url: /documentation/general_docs/ruby/MOESI_CMP_token
        - page: MESI two level
          url: /documentation/general_docs/ruby/MESI_Two_Level
        - page: Replacement Policies
          url: /documentation/general_docs/memory_system/replacement_policies


    - title: CPU Models
      id: cpu_models
      subitems:
        - page: SimpleCPU
          url: /documentation/general_docs/cpu_models/SimpleCPU
        - page: O3CPU
          url: /documentation/general_docs/cpu_models/O3CPU
        - page: TraceCPU
          url: /documentation/general_docs/cpu_models/TraceCPU
        - page: Minor CPU Model
          url: /documentation/general_docs/cpu_models/minor_cpu
        - page: Execution Basics
          url: /documentation/general_docs/cpu_models/execution_basics
        - page: Visualization
          url: /documentation/general_docs/cpu_models/visualization

    - title: M5ops
      id: m5ops
      url: /documentation/general_docs/m5ops

    - title: Checkpoints
      id: checkpoints
      url: /documentation/general_docs/checkpoints

    - title: Directed Testers
      id: directed_testers
      subitems:
        - page: Garnet Synthetic Traffic
          url: /documentation/general_docs/debugging_and_testing/directed_testers/garnet_synthetic_traffic
        - page: Ruby Random Tester
          url: /documentation/general_docs/debugging_and_testing/directed_testers/ruby_random_tester

    - title: Debugging
      id: debugging
      subitems:
        - page: Trace-based Debugging
          url: /documentation/general_docs/debugging_and_testing/debugging/trace_based_debugging
        - page: Debugger-based Debugging
          url: /documentation/general_docs/debugging_and_testing/debugging/debugger_based_debugging
        - page: Debugging Simulated Code
          url: /documentation/general_docs/debugging_and_testing/debugging/debugging_simulated_code
        - page: Reporting Problems
          url: /documentation/reporting_problems

    - title: Architecture Support
      id: architecture_support
      subitems:
        - page: Architecture Support
          url: /documentation/general_docs/architecture_support/
        - page: ARM Implementation
          url: /documentation/general_docs/architecture_support/arm_implementation/
        - page: ISA Parser
          url: /documentation/general_docs/architecture_support/isa_parser/
        - page: X86 microop ISA
          url: /documentation/general_docs/architecture_support/x86_microop_isa/

    - title: Power and Thermal Model
      url: /documentation/general_docs/thermal_model

    - title: Compiling Workloads
      id: compiling_workloads
      url: /documentation/general_docs/compiling_workloads/

    - title: Stats Package
      id: statistics
      url: /documentation/general_docs/statistics/
 
  - title: Learning gem5
    items:
    - title: Introduction
      id: introduction
      url: /documentation/learning_gem5/introduction

    - title: Getting Started
      id: part1
      subitems:
        - page: Building gem5
          url: /documentation/learning_gem5/part1/building
        - page: Creating a simple configuration script
          url: /documentation/learning_gem5/part1/simple_config
        - page: Adding cache to configuration script
          url: /documentation/learning_gem5/part1/cache_config
        - page: Understanding gem5 statistics and output
          url: /documentation/learning_gem5/part1/gem5_stats
        - page: Using the default configuration scripts
          url: /documentation/learning_gem5/part1/example_configs

    - title: Modifying/Extending
      id: part2
      subitems:
        - page: Setting up your development environment
          url: /documentation/learning_gem5/part2/environment
        - page: Creating a very simple SimObject
          url: /documentation/learning_gem5/part2/helloobject
        - page: Debugging gem5
          url: /documentation/learning_gem5/part2/debugging
        - page: Event-driven programming
          url: /documentation/learning_gem5/part2/events
        - page: Adding parameters to SimObjects and more events
          url: /documentation/learning_gem5/part2/parameters
        - page: Creating SimObjects in the memory system
          url: /documentation/learning_gem5/part2/memoryobject
        - page: Creating a simple cache object
          url: /documentation/learning_gem5/part2/simplecache

    - title: Modeling Cache Coherence with Ruby
      id: part3
      subitems:
        - page: Introduction to Ruby
          url: /documentation/learning_gem5/part3/MSIintro
        - page: MSI example cache protocol
          url: /documentation/learning_gem5/part3/cache-intro
        - page: Declaring a state machine
          url: /documentation/learning_gem5/part3/cache-declarations
        - page: In port code blocks
          url: /documentation/learning_gem5/part3/cache-in-ports
        - page: Action code blocks
          url: /documentation/learning_gem5/part3/cache-actions
        - page: Transition code blocks
          url: /documentation/learning_gem5/part3/cache-transitions
        - page: MSI Directory implementation
          url: /documentation/learning_gem5/part3/directory
        - page: Compiling a SLICC protocol
          url: /documentation/learning_gem5/part3/MSIbuilding
        - page: Configuring a simple Ruby system
          url: /documentation/learning_gem5/part3/configuration
        - page: Running the simple Ruby system
          url: /documentation/learning_gem5/part3/running
        - page: Debugging SLICC Protocols
          url: /documentation/learning_gem5/part3/MSIdebugging
        - page: Configuring for a standard protocol
          url: /documentation/learning_gem5/part3/simple-MI_example
    - title: gem5 101
      id: gem5_101
      url: /documentation/learning_gem5/gem5_101/

  - title: gem5 Doxygen
    items:
       - title: gem5 Doxygen
         id: doxygen
         url: https://gem5.github.io/gem5-doxygen

  - title: Reporting Problems
    items:
        - title: Reporting Problems
          id: reporting_problems
          url: /documentation/reporting_problems