2023-12-05 03:55:18

by Bhaskar Chowdhury

[permalink] [raw]
Subject: [PATCH] Documentaion:trace Add the git web link to view it on the browser

Thought this might help people to see the entire source tree on browser and
explore.

Signed-off-by: Bhaskar Chowdhury <[email protected]>
---
Documentation/trace/ftrace.rst | 2 ++
1 file changed, 2 insertions(+)

diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
index 23572f6697c0..e768a4c91452 100644
--- a/Documentation/trace/ftrace.rst
+++ b/Documentation/trace/ftrace.rst
@@ -3731,3 +3731,5 @@ Currently, -mfentry is used by gcc 4.6.0 and above on x86 only.
More
----
More details can be found in the source code, in the `kernel/trace/*.c` files.
+Also you can see the trace source tree on browser `Git Link
+<https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/kernel/trace>`__.
--
2.35.8


2023-12-05 16:28:17

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH] Documentaion:trace Add the git web link to view it on the browser

On Tue, 5 Dec 2023 09:25:17 +0530
Bhaskar Chowdhury <[email protected]> wrote:

> Thought this might help people to see the entire source tree on browser and
> explore.
>
> Signed-off-by: Bhaskar Chowdhury <[email protected]>
> ---
> Documentation/trace/ftrace.rst | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
> index 23572f6697c0..e768a4c91452 100644
> --- a/Documentation/trace/ftrace.rst
> +++ b/Documentation/trace/ftrace.rst
> @@ -3731,3 +3731,5 @@ Currently, -mfentry is used by gcc 4.6.0 and above on x86 only.
> More
> ----
> More details can be found in the source code, in the `kernel/trace/*.c` files.
> +Also you can see the trace source tree on browser `Git Link
> +<https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/kernel/trace>`__.
> --
> 2.35.8

I'm not a big fan of git links to code in the documentation tree. This is
more for those that want to play with it (compile and install), so I don't
think a web link is useful here. I rather have people download the code and
build it.

-- Steve