Using Cross-references

Using Cross-references#

Tip

To view the source of this document, click the “Show Source” option under the GitHub menu button on this page’s header.

Cross-references are a powerful way to embed links to your register reference anywhere in your documentation.

Basic cross-references#

Here is a basic example of some cross-references:

  1. Configure the my_soc.thingamabob.ctrl register to the desired settings.

  2. Enable the device by setting my_soc.thingamabob.ctrl.en to 1.

  3. Check my_soc.thingamabob.status for errors.

Using relative paths#

If your document is focusing on details for a particular component, it can be cumbersome to type out the entire path each time.

Here is the same example again, but without needing to specify the full path every time:

  1. Configure the ctrl register to the desired settings.

  2. Enable the device by setting ctrl.en to 1.

  3. Check status for errors.

Control link text#

By default, a link’s text will match the text used in the cross-reference.

The contents of the link text can be controlled in several ways: