Skip to contentSkip to conversation

Documentation/rv: Replace stale website link

PATCH Applied Gabriele Monaco 4 participants 7 messages Apr 27 – May 3

Subsystems (3)
lore
Share & tools
lore

Gabriele Monaco

author maintainer
#0 lore raw

PATCH v2 1/1 Documentation/rv: Replace stale website link

The sched monitor page was linking to Daniel's website which is now down. The main purpose of the link was to point to a source for the models from the original author and that can be found also in his published paper.

Replace the link with a reference to Daniel's "A thread synchronization model for the PREEMPT_RT Linux kernel" which can be found online and includes the models definitions as well as the work behind them (not the original patches but since they're based on a 5.0 kernel and are mostly included upstream, there's little value in keeping them in the docs).

Fixes 03abeaa63c08 ("Documentation/rv: Add docs for the sched monitors")

---
V2: Add link to the PDF and fixed RST references

 Documentation/trace/rv/monitor_sched.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
Documentation/trace/rv/monitor_sched.rst +5 -2
index 0b96d6e147c6..d3ba7edc202f 100644
@@ -36,7 +36,7 @@ Specifications
 --------------
 
 The specifications included in sched are currently a work in progress, adapting the ones
-defined in by Daniel Bristot in [1].
+defined by Daniel Bristot in [1]_.
 
 Currently we included the following:
 
@@ -365,4 +365,7 @@ constraints when processing the events::
 References
 ----------
 
-[1] - https://bristot.me/linux-task-model
+.. [1] Daniel Bristot de Oliveira et al.:
+       `A thread synchronization model for the PREEMPT_RT Linux kernel
+       <https://www.iris.sssup.it/bitstream/11382/533630/1/Elsevier-JSA-2020.pdf>`_,
+       J. Syst. Archit., 2020.

base-commit: 254f49634ee16a731174d2ae34bc50bd5f45e731

Signature · 1 line
2.53.0
reviewer Tested-by Acked-by on v2 1/1
#1 lore raw
Quoted 42 lines · Gabriele Monaco

The sched monitor page was linking to Daniel's website which is now down. The main purpose of the link was to point to a source for the models from the original author and that can be found also in his published paper.

Replace the link with a reference to Daniel's "A thread synchronization model for the PREEMPT_RT Linux kernel" which can be found online and includes the models definitions as well as the work behind them (not the original patches but since they're based on a 5.0 kernel and are mostly included upstream, there's little value in keeping them in the docs).

Fixes 03abeaa63c08 ("Documentation/rv: Add docs for the sched monitors")

---
V2: Add link to the PDF and fixed RST references

 Documentation/trace/rv/monitor_sched.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
Documentation/trace/rv/monitor_sched.rst +5 -2
index 0b96d6e147c6..d3ba7edc202f 100644
@@ -36,7 +36,7 @@ Specifications
 --------------
 
 The specifications included in sched are currently a work in progress, adapting the ones
-defined in by Daniel Bristot in [1].
+defined by Daniel Bristot in [1]_.
 
 Currently we included the following:
 
@@ -365,4 +365,7 @@ constraints when processing the events::
 References
 ----------
 
-[1] - https://bristot.me/linux-task-model
+.. [1] Daniel Bristot de Oliveira et al.:
+       `A thread synchronization model for the PREEMPT_RT Linux kernel
+       <https://www.iris.sssup.it/bitstream/11382/533630/1/Elsevier-JSA-2020.pdf>`_,
+       J. Syst. Archit., 2020.
Quoted 1 line

base-commit: 254f49634ee16a731174d2ae34bc50bd5f45e731

although I don't care for the "J. Syst. Archit." abbreviation. Does JSA use that? Not that I can see.

thanks.

Signature · 1 line
~Randy
author maintainer
#2 lore raw
Quoted 2 lines · Randy Dunlap

Thanks for the ack!

Quoted 2 lines

although I don't care for the "J. Syst. Archit." abbreviation. Does JSA use that? Not that I can see.

That's the citation format I got from semanticscholar.org , it's indeed a bit ugly but it's apparently the ISO 4 abbreviation [1].

Not sure if it would be neater to just use JSA which looks more official.

Thanks,
Gabriele

[1] - https://dblp.org/db/journals/jsa/index.html

reviewer
#3 lore raw
Quoted 11 lines · Gabriele Monaco
Quoted 2 lines · Randy Dunlap

Thanks for the ack!

Quoted 2 lines

although I don't care for the "J. Syst. Archit." abbreviation. Does JSA use that? Not that I can see.

That's the citation format I got from semanticscholar.org , it's indeed a bit ugly but it's apparently the ISO 4 abbreviation [1].

OK then. Leave it.
Thanks.

Quoted 8 lines

Not sure if it would be neater to just use JSA which looks more official.

Thanks,
Gabriele

[1] - https://dblp.org/db/journals/jsa/index.html

Signature · 1 line
~Randy
Acked-by Tested-by on v2 1/1
#4 lore raw
In reply to Gabriele Monaco

Hi Gabriele,

Quoted 42 lines · Gabriele Monaco

The sched monitor page was linking to Daniel's website which is now down. The main purpose of the link was to point to a source for the models from the original author and that can be found also in his published paper.

Replace the link with a reference to Daniel's "A thread synchronization model for the PREEMPT_RT Linux kernel" which can be found online and includes the models definitions as well as the work behind them (not the original patches but since they're based on a 5.0 kernel and are mostly included upstream, there's little value in keeping them in the docs).

Fixes 03abeaa63c08 ("Documentation/rv: Add docs for the sched monitors")

---
V2: Add link to the PDF and fixed RST references

 Documentation/trace/rv/monitor_sched.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
Documentation/trace/rv/monitor_sched.rst +5 -2
index 0b96d6e147c6..d3ba7edc202f 100644
@@ -36,7 +36,7 @@ Specifications
 --------------
 
 The specifications included in sched are currently a work in progress, adapting the ones
-defined in by Daniel Bristot in [1].
+defined by Daniel Bristot in [1]_.
 
 Currently we included the following:
 
@@ -365,4 +365,7 @@ constraints when processing the events::
 References
 ----------
 
-[1] - https://bristot.me/linux-task-model
+.. [1] Daniel Bristot de Oliveira et al.:
+       `A thread synchronization model for the PREEMPT_RT Linux kernel
+       <https://www.iris.sssup.it/bitstream/11382/533630/1/Elsevier-JSA-2020.pdf>`_,
+       J. Syst. Archit., 2020.
Quoted 5 lines

base-commit: 254f49634ee16a731174d2ae34bc50bd5f45e731

Signature · 1 line
2.53.0

Thanks for addressing this. FWIW this looks good to me, however I've just noticed that the same article is also referenced in rv/runtime-verification.rst with a slightly different format and no link. I think that it might be more clear if we had a References section in rv/runtime-verification.rst, add links to publicly available articles, and then let the other pages point to that section when needed instead of duplicating the references like in this case. But that could probably be addressed as a further clean-up patch.

Best regards,
Matteo Martelli

author maintainer
#5 lore raw

Hi Matteo,

Quoted 10 lines · Matteo Martelli

Thanks for addressing this. FWIW this looks good to me, however I've just noticed that the same article is also referenced in rv/runtime-verification.rst with a slightly different format and no link. I think that it might be more clear if we had a References section in rv/runtime-verification.rst, add links to publicly available articles, and then let the other pages point to that section when needed instead of duplicating the references like in this case. But that could probably be addressed as a further clean-up patch.

Quoted 2 lines

Thanks for the ack!

That's a good point, I agree it's better to go ahead with this small patch and I can make a deeper documentation cleanup later.

Thanks,
Gabriele

maintainer Applied
#6 lore raw
In reply to Gabriele Monaco
Quoted 11 lines · Gabriele Monaco

The sched monitor page was linking to Daniel's website which is now down. The main purpose of the link was to point to a source for the models from the original author and that can be found also in his published paper.

Replace the link with a reference to Daniel's "A thread synchronization model for the PREEMPT_RT Linux kernel" which can be found online and includes the models definitions as well as the work behind them (not the original patches but since they're based on a 5.0 kernel and are mostly included upstream, there's little value in keeping them in the docs).

Quoted 7 lines
Fixes 03abeaa63c08 ("Documentation/rv: Add docs for the sched monitors")

---
V2: Add link to the PDF and fixed RST references

 Documentation/trace/rv/monitor_sched.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Applied, thanks.

jon