Skip to content

Commit

Permalink
doc: move puncover down on the page.
Browse files Browse the repository at this point in the history
The puncover tool does not appear to be maintained anymore and it is
affected by multiple issues. Providing it as the first in the list
is a disservice to users as they might get frustrated and not notice
the `ram_report` tool that actually works.

Move the information at the bottom of the section, and add a warning
about the fact that this is a third party tool that might or might
not be working.

(Also make the link consistent to avoid "here" being a hyperlink, it
adds nothing to the reader either in RST or HTML.)

(cherry picked from commit 52426c2)

Original-Signed-off-by: Diego Elio Pettenò <flameeyes@meta.com>
GitOrigin-RevId: 52426c2
Change-Id: I48a33889b157ed5763b1d47e2754e2fa07836b7c
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/zephyr/+/4808572
Tested-by: Fabio Baltieri <fabiobaltieri@google.com>
Tested-by: ChromeOS Prod (Robot) <chromeos-ci-prod@chromeos-bot.iam.gserviceaccount.com>
Reviewed-by: Fabio Baltieri <fabiobaltieri@google.com>
Commit-Queue: Fabio Baltieri <fabiobaltieri@google.com>
  • Loading branch information
Flameeyes authored and Chromeos LUCI committed Aug 23, 2023
1 parent 3c514d0 commit 8313dda
Showing 1 changed file with 36 additions and 32 deletions.
68 changes: 36 additions & 32 deletions doc/develop/optimizations/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,38 +16,6 @@ stack usage analysis:

Tools that are available as build system targets:

Build Target: puncover
======================

This target uses a 3rd party tools called puncover which can be found `here
<https://github.com/HBehrens/puncover>`_. When this target is built, it will
launch a local web server which will allow you to open a web client and browse
the files and view their ROM, RAM and stack usage. Before you can use this
target, you will have to install the puncover python module::

pip3 install git+https://github.com/HBehrens/puncover --user


Then:

.. zephyr-app-commands::
:tool: all
:app: samples/hello_world
:board: reel_board
:goals: puncover


To view worst-case stack usage analysis, build this with the
:kconfig:option:`CONFIG_STACK_USAGE` enabled.

.. zephyr-app-commands::
:tool: all
:app: samples/hello_world
:board: reel_board
:goals: puncover
:gen-args: -DCONFIG_STACK_USAGE=y


Build Target: ram_report
========================

Expand Down Expand Up @@ -156,6 +124,42 @@ which will generate something similar to the output below::
...
...

Build Target: puncover
======================

This target uses a third-party tool called puncover which can be found at
https://github.com/HBehrens/puncover. When this target is built, it will
launch a local web server which will allow you to open a web client and browse
the files and view their ROM, RAM, and stack usage. Before you can use this
target, you will have to install the puncover python module::

pip3 install git+https://github.com/HBehrens/puncover --user

.. warning::

This is a third-party tool that might or might not be working at any given
time. Please check the GitHub issues, and report new problems to the
project maintainer.

Then:

.. zephyr-app-commands::
:tool: all
:app: samples/hello_world
:board: reel_board
:goals: puncover


To view worst-case stack usage analysis, build this with the
:kconfig:option:`CONFIG_STACK_USAGE` enabled.

.. zephyr-app-commands::
:tool: all
:app: samples/hello_world
:board: reel_board
:goals: puncover
:gen-args: -DCONFIG_STACK_USAGE=y


Data Structures
****************
Expand Down

0 comments on commit 8313dda

Please sign in to comment.