Skip to contentSkip to conversation

scripts/coccicheck: Update for a comment?

PATCH In review SF Markus Elfring 3 participants 13 messages Oct 7, 2016 – Oct 11, 2016

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

Hello,

Information from a commit like "docs: sphinxify coccinelle.txt and add it to dev-tools" caught also my software development attention.
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/Documentation/coccinelle.txt?id=4b9033a33494ec9154d63e706e9e47f7eb3fd59e

Did an other information from a comment become outdated in the script "coccicheck" because of such changes for the documentation format?
https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

Regards,
Markus

#1 lore raw
Quoted 9 lines · SF Markus Elfring

Hello,

Information from a commit like "docs: sphinxify coccinelle.txt and add it to dev-tools" caught also my software development attention.
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/Documentation/coccinelle.txt?id=4b9033a33494ec9154d63e706e9e47f7eb3fd59e

Did an other information from a comment become outdated in the script "coccicheck" because of such changes for the documentation format?
https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

How about submitting a patch to fix the problem?

julia

#3 lore raw
Quoted 6 lines · SF Markus Elfring
Quoted 3 lines
Quoted 1 line

https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

How about submitting a patch to fix the problem?

I would appreciate to become a bit more sure about the current storage location which should be referenced in this file.

In the Documentation directory find . -name "*cocci*"

gives

./dev-tools/coccinelle.rst

I think you could have done that yourself.

julia

Quoted 8 lines

Regards,
Markus
--
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in the body of a message to majordomo at vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

#4 lore raw
Quoted 7 lines
Quoted 6 lines
Quoted 3 lines
Quoted 1 line

https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

How about submitting a patch to fix the problem?

I would appreciate to become a bit more sure about the current storage location which should be referenced in this file.

Quoted 7 lines

In the Documentation directory find . -name "*cocci*"

gives

./dev-tools/coccinelle.rst

I think you could have done that yourself.

Does the usage of the format "reStructuredText" trigger further considerations like the following?

* Does your feedback suggest that the path from this source file should be put in related places?

* Would it make sense to store such a file name in a special variable?

* When would you refer to generated file formats (like PDF) for this use case?

Regards,
Markus

#5 lore raw
Quoted 18 lines · SF Markus Elfring
Quoted 7 lines
Quoted 6 lines
Quoted 3 lines
Quoted 1 line

https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

How about submitting a patch to fix the problem?

I would appreciate to become a bit more sure about the current storage location which should be referenced in this file.

Quoted 7 lines

In the Documentation directory find . -name "*cocci*"

gives

./dev-tools/coccinelle.rst

I think you could have done that yourself.

Does the usage of the format "reStructuredText" trigger further considerations like the following?

Quoted 6 lines

* Does your feedback suggest that the path from this source file should be put in related places?

* Would it make sense to store such a file name in a special variable?

* When would you refer to generated file formats (like PDF) for this use case?

Either you send the patch, or I will send the patch, when I have time, with no credit to you. I'm not an expert on all of the future plans for the documentation, The only think I know is where the file is now, and that the file is perfectly readable in its rst format, and thus it seems quite all right to reference it. If the situation change in the future, we can have another patch in the future.

julia

#6 lore raw
Quoted 2 lines

Either you send the patch, or I will send the patch, when I have time, with no credit to you.

I am curious when "the time" will be appropriate.

Quoted 1 line

I'm not an expert on all of the future plans for the documentation,

I assumed that you know a bit more about the corresponding software evolution than me.

Quoted 3 lines

The only think I know is where the file is now, and that the file is perfectly readable in its rst format, and thus it seems quite all right to reference it.

I can agree to such an information in principle.

Quoted 2 lines

If the situation change in the future, we can have another patch in the future.

I would appreciate another clarification:
Do I overlook any commit for the discussed source file anyhow?
https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/log/dev-tools/coccinelle.rst

Regards,
Markus

#8 lore raw

PATCH 1/1 scripts/coccicheck: Update reference for the corresponding documentation

In reply to Julia Lawall

From: Markus Elfring <[email protected]>
Date: Fri, 7 Oct 2016 16:06:15 +0200

Use the current name (in a comment at the beginning of this script) for the file which was converted to the documentation format "reStructuredText" in August 2016.

Fixes 4b9033a33494ec9154d63e706e9e47f7eb3fd59e ("docs: sphinxify coccinelle.txt and add it to dev-tools")
---
 scripts/coccicheck | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/coccicheck +1 -1
index c92c1528..ec487b8 100755
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Linux kernel coccicheck
 #
-# Read Documentation/coccinelle.txt
+# Read Documentation/dev-tools/coccinelle.rst
 #
 # This script requires at least spatch
 # version 1.0.0-rc11.
Signature · 1 line
2.10.1
Acked-by on v1 1/1
#9 lore raw

Re: [PATCH] scripts/coccicheck: Update reference for the corresponding documentation

Quoted 9 lines · SF Markus Elfring

From: Markus Elfring <[email protected]>
Date: Fri, 7 Oct 2016 16:06:15 +0200

Use the current name (in a comment at the beginning of this script) for the file which was converted to the documentation format "reStructuredText" in August 2016.

Fixes 4b9033a33494ec9154d63e706e9e47f7eb3fd59e ("docs: sphinxify coccinelle.txt and add it to dev-tools")
Quoted 25 lines
---
 scripts/coccicheck | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/coccicheck +1 -2
index c92c1528..ec487b8 100755
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Linux kernel coccicheck
 #
-# Read Documentation/coccinelle.txt
+# Read Documentation/dev-tools/coccinelle.rst
 #
 # This script requires at least spatch
 # version 1.0.0-rc11.
--

2.10.1

--
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in the body of a message to majordomo at vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

#10 lore raw

Re: [PATCH] scripts/coccicheck: Update reference for the corresponding documentation

Quoted 7 lines · Julia Lawall
Quoted 3 lines · SF Markus Elfring

From: Markus Elfring <[email protected]>
Date: Fri, 7 Oct 2016 16:06:15 +0200

Quoted 8 lines
Quoted 6 lines

Use the current name (in a comment at the beginning of this script) for the file which was converted to the documentation format "reStructuredText" in August 2016.

Fixes 4b9033a33494ec9154d63e706e9e47f7eb3fd59e ("docs: sphinxify coccinelle.txt and add it to dev-tools")

Applied to kbuild.git#misc, thanks.

Michal

#11 lore raw

Re: docs: Fixing "sphinxify coccinelle.txt"?

In reply to Julia Lawall
Quoted 9 lines
Quoted 7 lines

Information from a commit like "docs: sphinxify coccinelle.txt and add it to dev-tools" caught also my software development attention.
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/Documentation/coccinelle.txt?id=4b9033a33494ec9154d63e706e9e47f7eb3fd59e

Did an other information from a comment become outdated in the script "coccicheck" because of such changes for the documentation format?
https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

How about submitting a patch to fix the problem?

Is the published commit (from 2016-08-08 / 2016-08-18) generally questionable as I see it by the interface "cgit" at the moment?

* Does this one contain only the deletion of the file "Documentation/coccinelle.txt"?

* How should the result from the mentioned action "add it to dev-tools" look like finally?

* How could the acknowledgements happen for a software transformation which seems to be incomplete there?

I find another data display also interesting and more promising.
https://patchwork.kernel.org/patch/9269973/

* Should this patch about the desired file format conversion become available also by the other known interfaces?

* Would it have been nicer to include a corresponding update for the file "scripts/coccicheck" there, too?

* Do we need to clarify the distribution of the correct version any further?

Regards,
Markus

#12 lore raw

Re: docs: Fixing "sphinxify coccinelle.txt"?

Quoted 8 lines
Quoted 8 lines
Quoted 7 lines

Information from a commit like "docs: sphinxify coccinelle.txt and add it to dev-tools" caught also my software development attention.
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/Documentation/coccinelle.txt?id=4b9033a33494ec9154d63e706e9e47f7eb3fd59e

Did an other information from a comment become outdated in the script "coccicheck" because of such changes for the documentation format?
https://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/tree/scripts/coccicheck?id=c802e87fbe2d4dd58982d01b3c39bc5a781223aa#n4

Quoted 6 lines
Quoted 1 line

How about submitting a patch to fix the problem?

Is the published commit (from 2016-08-08 / 2016-08-18) generally questionable as I see it by the interface "cgit" at the moment?

* Does this one contain only the deletion of the file "Documentation/coccinelle.txt"?

It seems that I got an inappropriate impression from this kind of data display alone.

The display for the changed file name contains only the desired addition.
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/Documentation/dev-tools/coccinelle.rst?id=4b9033a33494ec9154d63e706e9e47f7eb3fd59e

Quoted 5 lines

I find another data display also interesting and more promising.
https://patchwork.kernel.org/patch/9269973/

* Should this patch about the desired file format conversion become available also by the other known interfaces?

The interface "cgit v0.12" does not indicate the involved "renaming" (similarity index 56%) so far which can be better seen in the downloadable patch file.

Regards,
Markus