From 804a210ccf522db205e21834b0fe6dd8bad0d1aa Mon Sep 17 00:00:00 2001 From: Douglas RAILLARD Date: Fri, 3 May 2019 11:51:09 +0100 Subject: [PATCH 1/2] doc: Move up doc link in lisa man page Make the online doc link more visible in the lisa man page. --- doc/lisa_shell/man/man.rst | 7 ++++--- doc/man1/lisa.1 | 8 +++++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/lisa_shell/man/man.rst b/doc/lisa_shell/man/man.rst index 4a03975a2..82b243902 100644 --- a/doc/lisa_shell/man/man.rst +++ b/doc/lisa_shell/man/man.rst @@ -9,6 +9,8 @@ Once you have all of the required dependencies installed, you can use the LISA shell, which provides a convenient set of commands for easy access to many LISA related functions, scripts and environment variables. +For more details, see +``_ ACTIVATION ++++++++++ @@ -34,9 +36,8 @@ Most LISA Shell commands start with ``lisa-``, thus using shell completion it is easy to get a list of all the available commands. Here is the documentation of the simple ones, more complex scripts have -integrated ``--help`` documentation sections [#]_, or man pages. - -.. [#] ``_ +integrated ``--help`` documentation, a section in the online documentation, or +man pages. Maintenance commands -------------------- diff --git a/doc/man1/lisa.1 b/doc/man1/lisa.1 index ef6e63957..02d4f55d0 100644 --- a/doc/man1/lisa.1 +++ b/doc/man1/lisa.1 @@ -35,6 +35,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] Once you have all of the required dependencies installed, you can use the LISA shell, which provides a convenient set of commands for easy access to many LISA related functions, scripts and environment variables. +.sp +For more details, see +\fI\%https://lisa\-linux\-integrated\-system\-analysis.readthedocs.io/en/master/\fP .SH ACTIVATION .sp In order to use the shell, source the script: @@ -69,9 +72,8 @@ Most LISA Shell commands start with \fBlisa\-\fP, thus using shell completion it is easy to get a list of all the available commands. .sp Here is the documentation of the simple ones, more complex scripts have -integrated \fB\-\-help\fP documentation sections [1], or man pages. -.IP [1] 5 -\fI\%https://lisa\-linux\-integrated\-system\-analysis.readthedocs.io/en/master/\fP +integrated \fB\-\-help\fP documentation, a section in the online documentation, or +man pages. .SS Maintenance commands .INDENT 0.0 .IP \(bu 2 -- GitLab From 7a4e195dbaa2073a26dbd6ff06369d4189739bb1 Mon Sep 17 00:00:00 2001 From: Douglas RAILLARD Date: Fri, 3 May 2019 12:09:29 +0100 Subject: [PATCH 2/2] README: warn about depracated classes in the slides The slides from 2016 contain references to classes that don't exist anymore, but since everything else still applies, just add a note about it and keep the link. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index aa0daaa8a..10e3f87ce 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,9 @@ Here are some noteworthy sections: [Slides](http://events.linuxfoundation.org/sites/events/files/slides/ELC16_LISA_20160326.pdf) and [Video](https://www.youtube.com/watch?v=yXZzzUEngiU) + Note: the LISA classes referred by the slides are outdated, but all the other + concepts and the overall architecture stays the same. + # License This project is licensed under Apache-2.0. -- GitLab