Skip to contentSkip to conversation

Documentation: Fix trivial nits

PATCH In review SeongJae Park 3 participants 10 messages Jan 31, 2020 – Feb 6, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover Documentation: Fix trivial nits

From: SeongJae Park <[email protected]>

This patchset fixes trivial nits in the documentations.

SeongJae Park (5):
docs/locking: Fix outdated section names docs/ko_KR/howto: Insert missing dots Documentation/ko_KR/howto: Update broken web addresses Documentation/ko_KR/howto: Update a broken link Documentation/memory-barriers: Fix typos

 Documentation/locking/spinlocks.rst        |  4 ++--
 Documentation/memory-barriers.txt          |  8 ++++----
 Documentation/translations/ko_KR/howto.rst | 10 +++++-----
 3 files changed, 11 insertions(+), 11 deletions(-)
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/5 docs/locking: Fix outdated section names

From: SeongJae Park <[email protected]>

Commit 2e4f5382d12a ("locking/doc: Rename LOCK/UNLOCK to ACQUIRE/RELEASE") has not appied to 'spinlock.rst'. This commit updates the doc for the change.

---
 Documentation/locking/spinlocks.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/locking/spinlocks.rst +2 -2
index 66e3792f8a36..bec96f7a9f2d 100644
@@ -25,9 +25,9 @@ worry about UP vs SMP issues: the spinlocks work correctly under both.
 
      Documentation/memory-barriers.txt
 
-       (5) LOCK operations.
+       (5) ACQUIRE operations.
 
-       (6) UNLOCK operations.
+       (6) RELEASE operations.
 
 The above is usually pretty simple (you usually need and want only one
 spinlock for most things - using more than one spinlock can make things a
Signature · 1 line
2.17.1
#2 lore raw

PATCH 2/5 docs/ko_KR/howto: Insert missing dots

In reply to SeongJae Park

From: SeongJae Park <[email protected]>

---
 Documentation/translations/ko_KR/howto.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/translations/ko_KR/howto.rst +2 -2
index ae3ad897d2ae..6419d8477689 100644
@@ -1,6 +1,6 @@
 NOTE:
-This is a version of Documentation/process/howto.rst translated into korean
-This document is maintained by Minchan Kim <[email protected]>
+This is a version of Documentation/process/howto.rst translated into korean.
+This document is maintained by Minchan Kim <[email protected]>.
 If you find any difference between this document and the original file or
 a problem with the translation, please contact the maintainer of this file.
 
Signature · 1 line
2.17.1
maintainer
#3 lore raw

Re: [PATCH 2/5] docs/ko_KR/howto: Insert missing dots

Quoted 3 lines · On Fri, 31 Jan 2020 21:52:34 +0100 SeongJae Park <[email protected]> wrote:

From: SeongJae Park <[email protected]>

I'd really rather not see patches with an empty changelog, please, even when they are relatively trivial. But also...

Quoted 9 lines
---
 Documentation/translations/ko_KR/howto.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/translations/ko_KR/howto.rst +0 -0
index ae3ad897d2ae..6419d8477689 100644

Documentation/translations/ko_KR/howto.rst line 3

Quoted 5 lines
Documentation/translations/ko_KR/howto.rst +2 -2
@@ -1,6 +1,6 @@
 NOTE:
-This is a version of Documentation/process/howto.rst translated into korean
-This document is maintained by Minchan Kim <[email protected]>
+This is a version of Documentation/process/howto.rst translated into korean.
+This document is maintained by Minchan Kim <[email protected]>.

Is this even true? Minchan hasn't touched this document in years, and you didn't see fit to copy him on the change. I'm thinking that adding periods doesn't seem like the right fix here.

Thanks,

jon

#4 lore raw

Re: Re: [PATCH 2/5] docs/ko_KR/howto: Insert missing dots

Quoted 9 lines · On Wed, 5 Feb 2020 10:15:55 -0700 Jonathan Corbet <[email protected]> wrote:
Quoted 3 lines · On Fri, 31 Jan 2020 21:52:34 +0100 SeongJae Park <[email protected]> wrote:

From: SeongJae Park <[email protected]>

I'd really rather not see patches with an empty changelog, please, even when they are relatively trivial. But also...

Sorry, will add changelog.

Quoted 5 lines
Quoted 5 lines
---
 Documentation/translations/ko_KR/howto.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Quoted 14 lines

Documentation/translations/ko_KR/howto.rst line 3

Quoted 10 lines
Documentation/translations/ko_KR/howto.rst +2 -2
index ae3ad897d2ae..6419d8477689 100644
@@ -1,6 +1,6 @@
 NOTE:
-This is a version of Documentation/process/howto.rst translated into korean
-This document is maintained by Minchan Kim <[email protected]>
+This is a version of Documentation/process/howto.rst translated into korean.
+This document is maintained by Minchan Kim <[email protected]>.

Is this even true? Minchan hasn't touched this document in years, and you didn't see fit to copy him on the change. I'm thinking that adding periods doesn't seem like the right fix here.

I only thought that this paragraph seems a little bit weird in the html doc due to the absence of the period. Also, thought that this change would be ok because it's just a simple change. Sorry if I was wrong. Anyway, please feel free to drop this patch.

Thanks,
SeongJae Park

Quoted 4 lines

Thanks,

jon

#5 lore raw

PATCH 3/5 Documentation/ko_KR/howto: Update broken web addresses

In reply to SeongJae Park

From: SeongJae Park <[email protected]>

Commit 0ea6e6112219 ("Documentation: update broken web addresses.") removed a link to 'http://patchwork.ozlabs.org' in howto, but the change has not applied to the Korean translation. This commit simply applies the change to the Korean translation. The link is restored now, though.

---
 Documentation/translations/ko_KR/howto.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/translations/ko_KR/howto.rst +2 -2
index 6419d8477689..627ce97810d1 100644
@@ -318,8 +318,8 @@ Andrew Morton의 글이 있다.
 리뷰 프로세스는 patchwork라는 도구를 통해 추적된다. patchwork은 등록된 패치와
 패치에 대한 코멘트, 패치의 버전을 볼 수 있는 웹 인터페이스를 제공하고,
 메인테이너는 패치를 리뷰 중, 리뷰 통과, 또는 반려됨으로 표시할 수 있다.
-대부분의 이러한 patchwork 사이트는 https://patchwork.kernel.org/ 또는
-http://patchwork.ozlabs.org/ 에 나열되어 있다.
+대부분의 이러한 patchwork 사이트는 https://patchwork.kernel.org/ 에 나열되어
+있다.
 
 통합 테스트를 위한 linux-next 커널 트리
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.17.1
#6 lore raw

PATCH 4/5 Documentation/ko_KR/howto: Update a broken link

In reply to SeongJae Park

From: SeongJae Park <[email protected]>

---
 Documentation/translations/ko_KR/howto.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/translations/ko_KR/howto.rst +1 -1
index 627ce97810d1..92840b7c63ef 100644
@@ -328,7 +328,7 @@ Andrew Morton의 글이 있다.
 거쳐야 한다. 이런 목적으로, 모든 서브시스템 트리의 변경사항을 거의 매일
 받아가는 특수한 테스트 저장소가 존재한다:
 
-       https://git.kernel.org/?p=linux/kernel/git/sfr/linux-next.git
+       https://git.kernel.org/?p=linux/kernel/git/next/linux-next.git
 
 이런 식으로, linux-next 커널을 통해 다음 머지 기간에 메인라인 커널에 어떤
 변경이 가해질 것인지 간략히 알 수 있다. 모험심 강한 테스터라면 linux-next
Signature · 1 line
2.17.1
#7 lore raw

PATCH 5/5 Documentation/memory-barriers: Fix typos

In reply to SeongJae Park

From: SeongJae Park <[email protected]>

---
 Documentation/memory-barriers.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/memory-barriers.txt +4 -4
index ec3b5865c1be..01ab5e22b670 100644
@@ -185,7 +185,7 @@ As a further example, consider this sequence of events:
 	===============	===============
 	{ A == 1, B == 2, C == 3, P == &A, Q == &C }
 	B = 4;		Q = P;
-	P = &B		D = *Q;
+	P = &B;		D = *Q;
 
 There is an obvious data dependency here, as the value loaded into D depends on
 the address retrieved from P by CPU 2.  At the end of the sequence, any of the
@@ -569,7 +569,7 @@ following sequence of events:
 	{ A == 1, B == 2, C == 3, P == &A, Q == &C }
 	B = 4;
 	<write barrier>
-	WRITE_ONCE(P, &B)
+	WRITE_ONCE(P, &B);
 			      Q = READ_ONCE(P);
 			      D = *Q;
 
@@ -1721,7 +1721,7 @@ of optimizations:
      and WRITE_ONCE() are more selective:  With READ_ONCE() and
      WRITE_ONCE(), the compiler need only forget the contents of the
      indicated memory locations, while with barrier() the compiler must
-     discard the value of all memory locations that it has currented
+     discard the value of all memory locations that it has currently
      cached in any machine registers.  Of course, the compiler must also
      respect the order in which the READ_ONCE()s and WRITE_ONCE()s occur,
      though the CPU of course need not do so.
@@ -1833,7 +1833,7 @@ Aside: In the case of data dependencies, the compiler would be expected
 to issue the loads in the correct order (eg. `a[b]` would have to load
 the value of b before loading a[b]), however there is no guarantee in
 the C specification that the compiler may not speculate the value of b
-(eg. is equal to 1) and load a before b (eg. tmp = a[1]; if (b != 1)
+(eg. is equal to 1) and load a[b] before b (eg. tmp = a[1]; if (b != 1)
 tmp = a[b]; ).  There is also the problem of a compiler reloading b after
 having loaded a[b], thus having a newer copy of b than a[b].  A consensus
 has not yet been reached about these problems, however the READ_ONCE()
Signature · 1 line
2.17.1
maintainer Reviewed-by on v1 5/5
#8 lore raw

Re: [PATCH 5/5] Documentation/memory-barriers: Fix typos

Quoted 3 lines · SeongJae Park

From: SeongJae Park <[email protected]>

Good catches, queued, thank you!

But if Jon would rather take this:

Thanx, Paul

Quoted 47 lines
---
 Documentation/memory-barriers.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/memory-barriers.txt +4 -4
index ec3b5865c1be..01ab5e22b670 100644
@@ -185,7 +185,7 @@ As a further example, consider this sequence of events:
 	===============	===============
 	{ A == 1, B == 2, C == 3, P == &A, Q == &C }
 	B = 4;		Q = P;
-	P = &B		D = *Q;
+	P = &B;		D = *Q;
 
 There is an obvious data dependency here, as the value loaded into D depends on
 the address retrieved from P by CPU 2.  At the end of the sequence, any of the
@@ -569,7 +569,7 @@ following sequence of events:
 	{ A == 1, B == 2, C == 3, P == &A, Q == &C }
 	B = 4;
 	<write barrier>
-	WRITE_ONCE(P, &B)
+	WRITE_ONCE(P, &B);
 			      Q = READ_ONCE(P);
 			      D = *Q;
 
@@ -1721,7 +1721,7 @@ of optimizations:
      and WRITE_ONCE() are more selective:  With READ_ONCE() and
      WRITE_ONCE(), the compiler need only forget the contents of the
      indicated memory locations, while with barrier() the compiler must
-     discard the value of all memory locations that it has currented
+     discard the value of all memory locations that it has currently
      cached in any machine registers.  Of course, the compiler must also
      respect the order in which the READ_ONCE()s and WRITE_ONCE()s occur,
      though the CPU of course need not do so.
@@ -1833,7 +1833,7 @@ Aside: In the case of data dependencies, the compiler would be expected
 to issue the loads in the correct order (eg. `a[b]` would have to load
 the value of b before loading a[b]), however there is no guarantee in
 the C specification that the compiler may not speculate the value of b
-(eg. is equal to 1) and load a before b (eg. tmp = a[1]; if (b != 1)
+(eg. is equal to 1) and load a[b] before b (eg. tmp = a[1]; if (b != 1)
 tmp = a[b]; ).  There is also the problem of a compiler reloading b after
 having loaded a[b], thus having a newer copy of b than a[b].  A consensus
 has not yet been reached about these problems, however the READ_ONCE()
Signature · 1 line
2.17.1
maintainer
#9 lore raw
In reply to SeongJae Park
Quoted 9 lines · On Fri, 31 Jan 2020 21:52:32 +0100 SeongJae Park <[email protected]> wrote:

his patchset fixes trivial nits in the documentations.

SeongJae Park (5):
docs/locking: Fix outdated section names docs/ko_KR/howto: Insert missing dots Documentation/ko_KR/howto: Update broken web addresses Documentation/ko_KR/howto: Update a broken link Documentation/memory-barriers: Fix typos

Quoted 4 lines
 Documentation/locking/spinlocks.rst        |  4 ++--
 Documentation/memory-barriers.txt          |  8 ++++----
 Documentation/translations/ko_KR/howto.rst | 10 +++++-----
 3 files changed, 11 insertions(+), 11 deletions(-)

OK, I've applied parts 1, 3, and 4. It looks like Paul picked up #5, and I had separate comments on #2.

Thanks,

jon