Skip to content

Commit

Permalink
Internal changes
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 439876720
Change-Id: Icd5a25d3be6425e9944f60cd903d8bb81683ccf5
  • Loading branch information
nilayvaish authored and copybara-github committed Apr 6, 2022
1 parent e10badd commit 9b42d0b
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,29 @@ platform support for TCMalloc.

All users of TCMalloc should consult the following documentation resources:

* The [TCMalloc Quickstart](docs/quickstart.md) covers downloading, installing,
building, and testing TCMalloc, including incorporating within your codebase.
* The [TCMalloc Overview](docs/overview.md) covers the basic architecture of
TCMalloc, and how that may affect configuration choices.
* The [TCMalloc Reference](docs/reference.md) covers the C and C++ TCMalloc API
endpoints.
* The [TCMalloc Quickstart](docs/quickstart.md) covers downloading,
installing, building, and testing TCMalloc, including incorporating within
your codebase.
* The [TCMalloc Overview](docs/overview.md) covers the basic architecture of
TCMalloc, and how that may affect configuration choices.
* The [TCMalloc Reference](docs/reference.md) covers the C and C++ TCMalloc
API endpoints.

More advanced usages of TCMalloc may find the following documentation useful:

* The [TCMalloc Tuning Guide](docs/tuning.md) covers the configuration choices
in more depth, and also illustrates other ways to customize TCMalloc. This
also covers important operating system-level properties for improving TCMalloc
performance.
* The [TCMalloc Design Doc](docs/design.md) covers how TCMalloc works
underneath the hood, and why certain design choices were made. Most developers
will not need this level of implementation detail.
* The [TCMalloc Compatibility Guide](docs/compatibility.md) which documents our
expectations for how our APIs are used.
* The [TCMalloc Tuning Guide](docs/tuning.md) covers the configuration
choices in more depth, and also illustrates other ways to customize
TCMalloc. This also covers important operating system-level properties for
improving TCMalloc performance.
* The [TCMalloc Design Doc](docs/design.md) covers how TCMalloc works
underneath the hood, and why certain design choices were made. Most
developers will not need this level of implementation detail.
* The [TCMalloc Compatibility Guide](docs/compatibility.md) which documents
our expectations for how our APIs are used.

## License

The TCMalloc library is licensed under the terms of the Apache
license. See LICENSE for more information.
The TCMalloc library is licensed under the terms of the Apache license. See
LICENSE for more information.

Disclaimer: This is not an officially supported Google product.

0 comments on commit 9b42d0b

Please sign in to comment.