Skip to content

Commit

Permalink
Update generated docs with new markdown headers (#1943)
Browse files Browse the repository at this point in the history
Generation scripts are updated in an internal change.

b/236404667

(cherry picked from commit 2ec4f7b)
  • Loading branch information
oxve authored and anonymous1-me committed Nov 16, 2023
1 parent 9ebdbc6 commit df2c267
Show file tree
Hide file tree
Showing 166 changed files with 5,184 additions and 5,182 deletions.
24 changes: 12 additions & 12 deletions cobalt/doc/memory_tuning.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Memory Tuning #
# Memory Tuning

Cobalt is designed to choose sensible parameters for memory-related options and
parameters through a system called "AutoMem".
Expand All @@ -16,7 +16,7 @@ Read on for more information.
*Setting `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` on the
command line is a beta feature.*

### Memory Settings Table ###
### Memory Settings Table

A table similar to the one below, will be printed on startup.

Expand Down Expand Up @@ -79,7 +79,7 @@ be set from a specific place or automatically generated from Cobalt.
* This value was AutoSet to a default value, but then was reduced in
response to `max_cobalt_cpu_usage` or `max_cobalt_gpu_usage being` set too low.

### Maximum Memory Table ###
### Maximum Memory Table

This second table is also printed at startup and details the sum of memory and
maximum memory limits as reported by cobalt.
Expand Down Expand Up @@ -128,13 +128,13 @@ consumed by the settings, then any settings that are AutoSet AND adjustable
will reduce their memory consumption. When this happens, look for the string
*`AutoSet (Constrained)`* in the first table.

## Setting Maximum Memory Values ##
## Setting Maximum Memory Values

The max cpu and gpu memory of the system can be set by command line:
* `--max_cobalt_cpu_usage=160MB`
* `--max_cobalt_gpu_usage=160MB`

### Memory Scaling ###
### Memory Scaling

There are two primary ways in which the memory consumption settings will scale down.
One is by specifying `--max_cobalt_cpu_usage` (or `max_cobalt_gpu_usage`) to a
Expand All @@ -152,15 +152,15 @@ flexible via the command line by setting the value to "autoset". For example,
`--image_cache_size_in_bytes=auto` will allow `image_cache_size_in_bytes` to be
flexible by disabling the value being set by a build setting.

### Memory Warnings ###
### Memory Warnings

Cobalt will periodically check to see if the memory consumed by the application
is less than the `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` amount.
If the cpu/gpu exceeds this maximum value then an error message will be logged
once to stdout for cpu and/or gpu memory systems.


### Example 1 - Configuring for a memory restricted platform ###
### Example 1 - Configuring for a memory restricted platform

Let's say that we are configuring platform called "XXX":

Expand All @@ -186,7 +186,7 @@ We will configure XXX such that:

* `cobalt --max_cobalt_cpu_usage=160MB`

### Example 2 - Configuring for a memory-plentiful platform ###
### Example 2 - Configuring for a memory-plentiful platform

The following command line will give a lot of memory to image cache and give
500MB to `max_cobalt_cpu_usage` and `max_cobalt_gpu_usage`.
Expand All @@ -196,9 +196,9 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
--image_cache_size_in_bytes=80MB
~~~

## API Reference ##
## API Reference

#### Memory System API ####
#### Memory System API

* `max_cobalt_cpu_usage`
* This setting will set the maximum cpu memory that the app will consume.
Expand All @@ -218,7 +218,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
for `max_cobalt_gpu_usage` in commandline/starboard settings then no
GPU memory checking is performed.

#### Memory Setting API ####
#### Memory Setting API

* `image_cache_size_in_bytes`
* See documentation *Image cache capacity* in `performance_tuning.md` for what
Expand Down Expand Up @@ -252,7 +252,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
for what this setting does.
* Set via command line, or else Cobalt extension, or else automatically by Cobalt.

#### Units for Command Line Settings ####
#### Units for Command Line Settings

Memory values passed into Cobalt via command line arguments support units such
kb, mb, and gb for kilo-byte, megabyte, gigabytes. These units are case insensitive.
Expand Down
22 changes: 11 additions & 11 deletions cobalt/site/docs/gen/cobalt/doc/memory_tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Read on for more information.
*Setting `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` on the
command line is a beta feature.*

### Memory Settings Table ###
### Memory Settings Table

A table similar to the one below, will be printed on startup.

Expand Down Expand Up @@ -83,7 +83,7 @@ be set from a specific place or automatically generated from Cobalt.
* This value was AutoSet to a default value, but then was reduced in
response to `max_cobalt_cpu_usage` or `max_cobalt_gpu_usage being` set too low.

### Maximum Memory Table ###
### Maximum Memory Table

This second table is also printed at startup and details the sum of memory and
maximum memory limits as reported by cobalt.
Expand Down Expand Up @@ -132,13 +132,13 @@ consumed by the settings, then any settings that are AutoSet AND adjustable
will reduce their memory consumption. When this happens, look for the string
*`AutoSet (Constrained)`* in the first table.

## Setting Maximum Memory Values ##
## Setting Maximum Memory Values

The max cpu and gpu memory of the system can be set by command line:
* `--max_cobalt_cpu_usage=160MB`
* `--max_cobalt_gpu_usage=160MB`

### Memory Scaling ###
### Memory Scaling

There are two primary ways in which the memory consumption settings will scale down.
One is by specifying `--max_cobalt_cpu_usage` (or `max_cobalt_gpu_usage`) to a
Expand All @@ -156,15 +156,15 @@ flexible via the command line by setting the value to "autoset". For example,
`--image_cache_size_in_bytes=auto` will allow `image_cache_size_in_bytes` to be
flexible by disabling the value being set by a build setting.

### Memory Warnings ###
### Memory Warnings

Cobalt will periodically check to see if the memory consumed by the application
is less than the `--max_cobalt_cpu_usage` and `--max_cobalt_gpu_usage` amount.
If the cpu/gpu exceeds this maximum value then an error message will be logged
once to stdout for cpu and/or gpu memory systems.


### Example 1 - Configuring for a memory restricted platform ###
### Example 1 - Configuring for a memory restricted platform

Let's say that we are configuring platform called "XXX":

Expand All @@ -190,7 +190,7 @@ We will configure XXX such that:

* `cobalt --max_cobalt_cpu_usage=160MB`

### Example 2 - Configuring for a memory-plentiful platform ###
### Example 2 - Configuring for a memory-plentiful platform

The following command line will give a lot of memory to image cache and give
500MB to `max_cobalt_cpu_usage` and `max_cobalt_gpu_usage`.
Expand All @@ -200,9 +200,9 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
--image_cache_size_in_bytes=80MB
~~~

## API Reference ##
## API Reference

#### Memory System API ####
#### Memory System API

* `max_cobalt_cpu_usage`
* This setting will set the maximum cpu memory that the app will consume.
Expand All @@ -222,7 +222,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
for `max_cobalt_gpu_usage` in commandline/starboard settings then no
GPU memory checking is performed.

#### Memory Setting API ####
#### Memory Setting API

* `image_cache_size_in_bytes`
* See documentation *Image cache capacity* in `performance_tuning.md` for what
Expand Down Expand Up @@ -256,7 +256,7 @@ cobalt --max_cobalt_cpu_usage=500MB --max_cobalt_gpu_usage=500MB
for what this setting does.
* Set via command line, or else Cobalt extension, or else automatically by Cobalt.

#### Units for Command Line Settings ####
#### Units for Command Line Settings

Memory values passed into Cobalt via command line arguments support units such
kb, mb, and gb for kilo-byte, megabyte, gigabytes. These units are case insensitive.
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/starboard/tools/doc/abstract_launcher.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "App Launchers"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# App Launchers

The app launcher framework is used to run an executable on a given platform,
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/starboard/tools/doc/testing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Test Runner Documentation"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Test Runner Documentation

The scripts in this folder comprise a cross-platform unit test runner. The
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/reference/starboard/configuration-public.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Starboard Configuration Reference Guide"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

Starboard Configuration Reference Guide

## Architecture Configuration

Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/reference/starboard/gn-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Starboard: configuration.gni Reference Guide"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Starboard: configuration.gni Reference Guide

| Variables |
| :--- |
Expand Down
Loading

0 comments on commit df2c267

Please sign in to comment.