_data/documentation.yml

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/gem5_101

      - title: Hello World
        url: /documentation/gem5_101/hello_world

      - title: Adding An Instruction
        url: /documentation/gem5_101/adding_an_instruction

      - title: CPU Models
        url: /documentation/gem5_101/cpu_models

      - title: Branch Prediction
        url: /documentation/gem5_101/branch_prediction

      - title: Caches
        url: /documentation/gem5_101/caches

      - title: Multi Core
        url: /documentation/gem5_101/multi_core