Skip to content

docs: ftrace: Fix minor issues in the doc

Frank A. Cancio Bello linux-doc lkml 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest3 patches 2 repliesIn review
  2. v2 RFC2 patches 3 repliesSuperseded
  3. v1 RFC2 patches 7 repliesSuperseded

Changes in v3 from the cover letter

- Sorry, I'm sending this v3 with no changes but the subject of the emails because I forgot to tag the last batch as v2. You can ignore the previous versions of this patchset. I'm still getting used to the versioning of the patches and all that, my apologies.

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3docs: ftrace: Clarify the RAM impact of buffer_size_kbDocumentation/trace/ftrace.rst+2 -10 replies
2/3docs: ftrace: Fix typosDocumentation/trace/ftrace.rst+3 -30 replies
3/3docs: ftrace: Fix small notation mistakeDocumentation/trace/ring-buffer-design.txt+1 -10 replies

Reviews trailers per patch

None of the 3 patches has a Reviewed-by or Acked-by of their own; the series has one for all of them.

PatchSteven Rostedt (VMware)Joel Fernandes (Google)
SeriesR-b R-b
1/3
2/3
3/3

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v3 thread

Cover letter [PATCH v3 0/3] docs: ftrace: Fix minor issues in the doc

I didn't want to be pushy with these minor fixes but occur to me now that, even all seem to be clear in the latest version of the RFC (v2) related to these fixes, a clean patchset could be expected after such RFC. So here we go:

Clarifies the RAM footprint of buffer_size_kb without getting into implementation details.

Fix typos and a small notation mistakes in the doc.

Changes since v2:
- Sorry, I'm sending this v3 with no changes but the subject of the emails because I forgot to tag the last batch as v2. You can ignore the previous versions of this patchset. I'm still getting used to the versioning of the patches and all that, my apologies.

Changes since v1:
- Improves the redaction as per Randy suggestion.

Changes since RFC v2:
- Take out the notation mistake into its own commit because it is not a typo.

Changes since RFC v1:
- Removes implementation description of the RAM footprint of buffer_size_kb, but still make the corresponded clarification.

- Removes a patch that was just for illustration purposes because Steven already got the issue that I was referring to.

- Adds a patch to fix other typos in the doc.

Frank A. Cancio Bello (3):
docs: ftrace: Clarify the RAM impact of buffer_size_kb
docs: ftrace: Fix typos
docs: ftrace: Fix small notation mistake

 Documentation/trace/ftrace.rst             | 9 +++++----
 Documentation/trace/ring-buffer-design.txt | 2 +-
 2 files changed, 6 insertions(+), 5 deletions(-)
Signature · 1 line
2.17.1