title: Documentation

docs:

  - 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
    items:
      - title: gem5 101
        url: /documentation/gem5_101/

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

  - title: Building
    id: building
    items:
      - title: EXTRAS
        url: /documentation/general_docs/building/EXTRAS

  - title: Full System
    items:
      - title: Creating Disk Images
        url: /documentation/general_docs/fullsystem/disks
      - title: Devices
        url: /documentation/general_docs/fullsystem/devices

  - title: Memory System
    items:
      - title: Memory System
        url: /documentation/general_docs/memory_system/

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

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

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

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

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

  - title: CPU Models
    id: cpu_models
    items:
    - title: 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
    - title: Execution Basics
      url: /documentation/general_docs/cpu_models/execution_basics

  - title: M5ops
    items:
        - title: M5ops
          url: /documentation/general_docs/M5ops

  - title: Checkpoints
    items:
        - title: Checkpoints
          url: /documentation/general_docs/Checkpoints


  - title: Debugging and Testing
    items:
    - title: Debugging and Testing
      id: debugging_and_testing
      url: /documentation/general_docs/debugging_and_testing/debugging_and_testing

    - 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

  - title: Architecture Support
    items:
      - title: Architecture Support
        url: /documentation/general_docs/architecture_support/

      - title: ARM Implementation
        url: /documentation/general_docs/architecture_support/arm_implementation/

      - title: ISA Parser
        url: /documentation/general_docs/architecture_support/isa_parser/

      - title: X86 microop ISA
        url: /documentation/general_docs/architecture_support/x86_microop_isa/

  - title: Compiling Workloads
    items:
      - title: Compiling Workloads
        url: /documentation/general_docs/compiling_workloads/
  
  - title: Statistics
    items:       
      - title: Statistics
        url: /documentation/general_docs/statistics/

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