Fix some issues at documentation

Changeset b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
renamed: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
to: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml.

Update its cross-reference accordingly.

Fixes b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")

Reviewed-by Linus Walleij <[email protected]>

Acked-by Sudeep Holla <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Quoted 4 lines · Mauro Carvalho Chehab

Changeset b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
renamed: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
to: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml.

Quoted 6 lines

Update its cross-reference accordingly.

Fixes b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")

Reviewed-by Linus Walleij <[email protected]>

Acked-by Sudeep Holla <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

I suppose Marc Z could merge this into the irqchips tree?

Changeset 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")
renamed: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
to: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml.

Update its cross-reference accordingly.

Fixes 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")

Reviewed-by Linus Walleij <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

The file name: Documentation/devicetree/bindings/display/intel,ixp46x-rng.yaml should be, instead: Documentation/devicetree/bindings/rng/intel,ixp46x-rng.yaml.

Update its cross-reference accordingly.

Fixes cca061b04c0d ("hw_random: ixp4xx: Add DT bindings")

Reviewed-by Linus Walleij <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Changeset 7da6ebf5f5a5 ("dt-bindings: arm: Convert Gemini boards to YAML")
renamed: Documentation/devicetree/bindings/arm/gemini.txt
to: Documentation/devicetree/bindings/arm/gemini.yaml.

Update its cross-reference accordingly.

Fixes 7da6ebf5f5a5 ("dt-bindings: arm: Convert Gemini boards to YAML")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Changeset 5d1c5594b646 ("dt-bindings: net: brcm,unimac-mdio: convert to the json-schema")
renamed: Documentation/devicetree/bindings/net/brcm,unimac-mdio.txt
to: Documentation/devicetree/bindings/net/brcm,unimac-mdio.yaml.

Update its cross-reference accordingly.

Fixes 5d1c5594b646 ("dt-bindings: net: brcm,unimac-mdio: convert to the json-schema")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Changeset 63f8e9e0ac65 ("dt-bindings: mtd: Convert mtd-physmap to DT schema")
renamed: Documentation/devicetree/bindings/mtd/arm-versatile.txt
and: Documentation/devicetree/bindings/mtd/cypress,hyperflash.txt
to: Documentation/devicetree/bindings/mtd/mtd-physmap.yaml.

Update their cross-references accordingly.

Fixes 63f8e9e0ac65 ("dt-bindings: mtd: Convert mtd-physmap to DT schema")

Acked-by Miquel Raynal <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Changeset 2f5947dfcaec ("Documentation: move Documentation/virtual to Documentation/virt")
renamed: Documentation/virtual/kvm/vcpu-requests.rst
to: Documentation/virt/kvm/vcpu-requests.rst.

Update its cross-reference accordingly.

Fixes 2f5947dfcaec ("Documentation: move Documentation/virtual to Documentation/virt")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei at kernel.org/

 arch/riscv/kvm/vcpu.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

arch/riscv/kvm/vcpu.c +1 -2

index c44cabce7dd8..260ce0779a32 100644
@@ -912,7 +912,7 @@ int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu)
                 * Ensure we set mode to IN_GUEST_MODE after we disable
                 * interrupts and before the final VCPU requests check.
                 * See the comment in kvm_vcpu_exiting_guest_mode() and
-                * Documentation/virtual/kvm/vcpu-requests.rst
+                * Documentation/virt/kvm/vcpu-requests.rst
                 */
                vcpu->mode = IN_GUEST_MODE;
 
--

2.31.1

_______________________________________________
linux-riscv mailing list
linux-riscv at lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

The file name: Documentation/bpftool-cgroup.rst
should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.

Update its cross-reference accordingly.

Fixes a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")

Fixes 5ccda64d38cc ("bpftool: implement cgroup bpf operations")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

tools/testing/selftests/bpf/test_bpftool_synctypes.py +0 -0

index be54b7335a76..617b8084c440 100755

2021-10-19 09:04 UTC+0100 ~ Mauro Carvalho Chehab
<[email protected]>

Quoted 27 lines

The file name: Documentation/bpftool-cgroup.rst
should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.

Update its cross-reference accordingly.

Fixes a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")

Fixes 5ccda64d38cc ("bpftool: implement cgroup bpf operations")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

tools/testing/selftests/bpf/test_bpftool_synctypes.py +1 -1

index be54b7335a76..617b8084c440 100755
@@ -392,7 +392,7 @@ class ManCgroupExtractor(ManPageExtractor):
     """
     An extractor for bpftool-cgroup.rst.
     """
-    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')
+    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')
 

tools/testing/selftests/bpf/test_bpftool_synctypes.py class ManCgroupExtractor(ManPageExtractor): · line 398

Quoted 3 lines

tools/testing/selftests/bpf/test_bpftool_synctypes.py +0 -0

     def get_attach_types(self):
         return self.get_rst_list('ATTACH_TYPE')

No, this change is incorrect. We have discussed it several times before [0][1]. Please drop this patch.

Quoted 30 lines

2021-10-19 09:04 UTC+0100 ~ Mauro Carvalho Chehab
<[email protected]>

Quoted 27 lines

The file name: Documentation/bpftool-cgroup.rst
should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.

Update its cross-reference accordingly.

Fixes a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")

Fixes 5ccda64d38cc ("bpftool: implement cgroup bpf operations")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

tools/testing/selftests/bpf/test_bpftool_synctypes.py +1 -1

index be54b7335a76..617b8084c440 100755
@@ -392,7 +392,7 @@ class ManCgroupExtractor(ManPageExtractor):
     """
     An extractor for bpftool-cgroup.rst.
     """
-    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')
+    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')
 

Quoted 6 lines

tools/testing/selftests/bpf/test_bpftool_synctypes.py class ManCgroupExtractor(ManPageExtractor): · line 398

Quoted 3 lines

tools/testing/selftests/bpf/test_bpftool_synctypes.py +0 -0

     def get_attach_types(self):
         return self.get_rst_list('ATTACH_TYPE')

No, this change is incorrect. We have discussed it several times before [0][1]. Please drop this patch.

+1

Without .rst extension, ./scripts/documentation-file-ref-check will produce a warning, and auto-generating cross-references by automarkup.py may not work.

Fixes 8137a49e1567 ("docs/zh_CN: Modify the translator tag and fix the wrong word")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 Documentation/translations/zh_CN/core-api/irq/irq-affinity.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/translations/zh_CN/core-api/irq/irq-affinity.rst +0 -0

index 7addd5f27a88..36b085226d0b 100644

memory_hotplug.rst -> memory-hotplug.rst

Fixes 620127548a69 ("docs/zh_CN: add core api memory_hotplug translation")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 Documentation/translations/zh_CN/core-api/memory-hotplug.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/translations/zh_CN/core-api/memory-hotplug.rst +0 -0

index 9a204eb196f2..9b2841fb9a5f 100644

Dumb question that probably has been asked a couple of times already:
why do we even maintain a translated doc in-tree?

Every time I do an update on the original doc, I for sure can only guess which translated parts need updating. And I really can only update when "deleting", not when rewording/adding. So we'll be left with stale doc that will have to be updated manually by $whoever.

I don't feel very
confident about this. No translated doc is better than outdated translated doc.

This feels like something that should be maintained out of tree. My 2 cents.

--
Thanks,

David / dhildenb

Quoted 6 lines · David Hildenbrand

Dumb question that probably has been asked a couple of times already:
why do we even maintain a translated doc in-tree?

Every time I do an update on the original doc, I for sure can only guess which translated parts need updating. And I really can only update when

Quoted 2 lines

"deleting", not when rewording/adding. So we'll be left with stale doc that will have to be updated manually by $whoever.

cc to the translation maintainers and translator would be helpful?

Quoted 4 lines

I don't feel very
confident about this. No translated doc is better than outdated translated doc.

Uh, I don't know other languages, but in Chinese, 15 years before translated books are still selling well in China. :)
https://item.jd.com/1075130482.html -> Linux device driver
https://item.jd.com/10100237.html -> Understanding linux kernel

Quoted 6 lines · Alex Shi <[email protected]> 于2021年11月1日周一 下午3:48写道：

Quoted 4 lines · David Hildenbrand

Dumb question that probably has been asked a couple of times already:
why do we even maintain a translated doc in-tree?

Quoted 2 lines

Quoted 2 lines

Every time I do an update on the original doc, I for sure can only guess which translated parts need updating. And I really can only update when

Dear David

Thank you very much for your contribution, in fact, we are always updating the translations and improving the speed of the sync, so If you are not good at Chinese
and want to get the sync faster, please CC us when you send the patch.

Quoted 4 lines

Quoted 2 lines

"deleting", not when rewording/adding. So we'll be left with stale doc that will have to be updated manually by $whoever.

cc to the translation maintainers and translator would be helpful?

Alex,Maybe we should provide a translation guide in English, e.g::

Dear developers, if you have trouble updating the Chinese documentation after updating the original documentation, please CC the translator of
that documentation
and the maintainer of the Chinese documentation, and the relevant
documentation
will be updated soon.

Quoted 5 lines

Quoted 4 lines

I don't feel very
confident about this. No translated doc is better than outdated translated doc.

Quoted 4 lines

Uh, I don't know other languages, but in Chinese, 15 years before translated books are still selling well in China. :)
https://item.jd.com/1075130482.html -> Linux device driver
https://item.jd.com/10100237.html -> Understanding linux kernel

Yes, I just bought a LDD3 last week.! >_<

The mandatory file locking got removed due to its problems, but the fs locks documentation still points to it.

Update the text there, informing that it was removed on Kernel 5.14.

Fixes f7e33bdbd6d1 ("fs: remove mandatory file locking support")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 Documentation/filesystems/locks.rst | 17 +++++------------
 1 file changed, 5 insertions(+), 12 deletions(-)

Documentation/filesystems/locks.rst +0 -8

index c5ae858b1aac..26429317dbbc 100644
@@ -57,16 +57,9 @@ fcntl(), with all the problems that implies.
 1.3 Mandatory Locking As A Mount Option
 ---------------------------------------
 
-Mandatory locking, as described in
-'Documentation/filesystems/mandatory-locking.rst' was prior to this release a
-general configuration option that was valid for all mounted filesystems.  This
-had a number of inherent dangers, not the least of which was the ability to
-freeze an NFS server by asking it to read a file for which a mandatory lock
-existed.
-
-From this release of the kernel, mandatory locking can be turned on and off

The mandatory file locking got removed due to its problems, but there's still a comment inside fs/locks.c pointing to the removed doc.

Remove it.

Fixes f7e33bdbd6d1 ("fs: remove mandatory file locking support")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 fs/locks.c | 1 -
 1 file changed, 1 deletion(-)

fs/locks.c +0 -0

index d397394633be..94feadcdab4e 100644

Quoted 16 lines · Mauro Carvalho Chehab

The mandatory file locking got removed due to its problems, but there's still a comment inside fs/locks.c pointing to the removed doc.

Remove it.

Fixes f7e33bdbd6d1 ("fs: remove mandatory file locking support")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 fs/locks.c | 1 -
 1 file changed, 1 deletion(-)

fs/locks.c line 66

Quoted 12 lines

fs/locks.c +0 -1

index d397394633be..94feadcdab4e 100644
@@ -61,7 +61,6 @@
  *
  *  Initial implementation of mandatory locks. SunOS turned out to be
  *  a rotten model, so I implemented the "obvious" semantics.
- *  See 'Documentation/filesystems/mandatory-locking.rst' for details.
  *  Andy Walker ([email protected]), April 06, 1996.
  *
  *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to

Thanks Mauro. I'll pick this into my locks branch, so it should make v5.16 as well.

Quoted 17 lines · Jeff Layton

Quoted 16 lines · Mauro Carvalho Chehab

The mandatory file locking got removed due to its problems, but there's still a comment inside fs/locks.c pointing to the removed doc.

Remove it.

Fixes f7e33bdbd6d1 ("fs: remove mandatory file locking support")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 fs/locks.c | 1 -
 1 file changed, 1 deletion(-)

Quoted 15 lines

fs/locks.c line 66

Quoted 12 lines

fs/locks.c +0 -1

index d397394633be..94feadcdab4e 100644
@@ -61,7 +61,6 @@
  *
  *  Initial implementation of mandatory locks. SunOS turned out to be
  *  a rotten model, so I implemented the "obvious" semantics.
- *  See 'Documentation/filesystems/mandatory-locking.rst' for details.
  *  Andy Walker ([email protected]), April 06, 1996.
  *
  *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to

Thanks Mauro. I'll pick this into my locks branch, so it should make v5.16 as well.

Could we delete the rest too?

We don't do those changelog-style comments any more; they're in the git history if you need them. I can sort of get leaving some in out of respect or if they've still provide some useful information. But keeping comments referring to code that doesn't even exist any more just seems confusing.

--b.

fs/locks.c +0 -11

index 3d6fb4ae847b..2540b7aedeac 100644
@@ -59,17 +59,6 @@
  *  once we've checked for blocking and deadlocking.
  *  Andy Walker ([email protected]), April 03, 1996.
  *
- *  Initial implementation of mandatory locks. SunOS turned out to be
- *  a rotten model, so I implemented the "obvious" semantics.
- *  See 'Documentation/filesystems/mandatory-locking.rst' for details.
- *  Andy Walker ([email protected]), April 06, 1996.
- *
- *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to
- *  check if a file has mandatory locks, used by mmap(), open() and creat() to
- *  see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
- *  Manual, Section 2.
- *  Andy Walker ([email protected]), April 09, 1996.
- *
  *  Tidied up block list handling. Added '/proc/locks' interface.
  *  Andy Walker ([email protected]), April 24, 1996.
  *

IDK...Do we want to "erase history" selectively like that?

Maybe we should just get rid of the whole pile of "changelog" comments in fs/locks.c? They aren't terribly useful these days anyhow.

Quoted 1 line · Jeff Layton

IDK...Do we want to "erase history" selectively like that?

Seems like pretty spotty history anyway, so I don't think it's a problem, but...

Quoted 2 lines

Maybe we should just get rid of the whole pile of "changelog" comments in fs/locks.c? They aren't terribly useful these days anyhow.

... that'd be fine with me.

I didn't mainly because I thought it'd be good to read through it and see if there's anything that should be salvaged.

Reading through it now:

The last few paragraphs (under "Locking conflicts and dependencies" were added more recently by Neil and are still useful.

I'd be OK losing the rest.

It might still be good to have some basic introduction; maybe something like this?:

--b.

fs/locks.c +4 -103

index 3d6fb4ae847b..b54813eae44f 100644
@@ -2,117 +2,11 @@
 /*
  *  linux/fs/locks.c
  *
- *  Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
- *  Doug Evans ([email protected]), August 07, 1992
+ * We implement four types of file locks: BSD locks, posix locks, open
+ * file description locks, and leases.  For details about BSD locks,
+ * see the flock(2) man page; for details about the other three, see
+ * fcntl(2).
  *
- *  Deadlock detection added.
- *  FIXME: one thing isn't handled yet:
- *	- mandatory locks (requires lots of changes elsewhere)
- *  Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
- *
- *  Miscellaneous edits, and a total rewrite of posix_lock_file() code.
- *  Kai Petzke ([email protected]), 1994
- *
- *  Converted file_lock_table to a linked list from an array, which eliminates
- *  the limits on how many active file locks are open.
- *  Chad Page ([email protected]), November 27, 1994
- *
- *  Removed dependency on file descriptors. dup()'ed file descriptors now
- *  get the same locks as the original file descriptors, and a close() on
- *  any file descriptor removes ALL the locks on the file for the current
- *  process. Since locks still depend on the process id, locks are inherited
- *  after an exec() but not after a fork(). This agrees with POSIX, and both
- *  BSD and SVR4 practice.
- *  Andy Walker ([email protected]), February 14, 1995
- *
- *  Scrapped free list which is redundant now that we allocate locks
- *  dynamically with kmalloc()/kfree().
- *  Andy Walker ([email protected]), February 21, 1995
- *
- *  Implemented two lock personalities - FL_FLOCK and FL_POSIX.
- *
- *  FL_POSIX locks are created with calls to fcntl() and lockf() through the
- *  fcntl() system call. They have the semantics described above.
- *
- *  FL_FLOCK locks are created with calls to flock(), through the flock()
- *  system call, which is new. Old C libraries implement flock() via fcntl()
- *  and will continue to use the old, broken implementation.
- *
- *  FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
- *  with a file pointer (filp). As a result they can be shared by a parent
- *  process and its children after a fork(). They are removed when the last
- *  file descriptor referring to the file pointer is closed (unless explicitly
- *  unlocked).
- *
- *  FL_FLOCK locks never deadlock, an existing lock is always removed before
- *  upgrading from shared to exclusive (or vice versa). When this happens
- *  any processes blocked by the current lock are woken up and allowed to
- *  run before the new lock is applied.
- *  Andy Walker ([email protected]), June 09, 1995
- *
- *  Removed some race conditions in flock_lock_file(), marked other possible
- *  races. Just grep for FIXME to see them.
- *  Dmitry Gorodchanin ([email protected]), February 09, 1996.
- *
- *  Addressed Dmitry's concerns. Deadlock checking no longer recursive.
- *  Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
- *  once we've checked for blocking and deadlocking.
- *  Andy Walker ([email protected]), April 03, 1996.
- *
- *  Initial implementation of mandatory locks. SunOS turned out to be
- *  a rotten model, so I implemented the "obvious" semantics.
- *  See 'Documentation/filesystems/mandatory-locking.rst' for details.
- *  Andy Walker ([email protected]), April 06, 1996.
- *
- *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to
- *  check if a file has mandatory locks, used by mmap(), open() and creat() to
- *  see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
- *  Manual, Section 2.
- *  Andy Walker ([email protected]), April 09, 1996.
- *
- *  Tidied up block list handling. Added '/proc/locks' interface.
- *  Andy Walker ([email protected]), April 24, 1996.
- *
- *  Fixed deadlock condition for pathological code that mixes calls to
- *  flock() and fcntl().
- *  Andy Walker ([email protected]), April 29, 1996.
- *
- *  Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
- *  for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
- *  guarantee sensible behaviour in the case where file system modules might
- *  be compiled with different options than the kernel itself.
- *  Andy Walker ([email protected]), May 15, 1996.
- *
- *  Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
- *  ([email protected]) for spotting this.
- *  Andy Walker ([email protected]), May 15, 1996.
- *
- *  Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
- *  locks. Changed process synchronisation to avoid dereferencing locks that
- *  have already been freed.
- *  Andy Walker ([email protected]), Sep 21, 1996.
- *
- *  Made the block list a circular list to minimise searching in the list.
- *  Andy Walker ([email protected]), Sep 25, 1996.
- *
- *  Made mandatory locking a mount option. Default is not to allow mandatory
- *  locking.
- *  Andy Walker ([email protected]), Oct 04, 1996.
- *
- *  Some adaptations for NFS support.
- *  Olaf Kirch ([email protected]), Dec 1996,
- *
- *  Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
- *  Andy Walker ([email protected]), May 12, 1997.
- *
- *  Use slab allocator instead of kmalloc/kfree.

Yeah, I think that looks great. Send it with a changelog and I'll pull it into the branch I have feeding into -next.

From: "J. Bruce Fields" <[email protected]>

This is only of historical interest, and anyone interested in the history can dig out an old version of locks.c from from git.

Triggered by the observation that it references the now-removed Documentation/filesystems/mandatory-locking.rst.

Reported-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by J. Bruce Fields <[email protected]>

---
 fs/locks.c | 114 ++---------------------------------------------------
 1 file changed, 4 insertions(+), 110 deletions(-)

Quoted 2 lines · Jeff Layton

Yeah, I think that looks great. Send it with a changelog and I'll pull it into the branch I have feeding into -next.

OK!--b.

fs/locks.c +4 -103

index 3d6fb4ae847b..b54813eae44f 100644
@@ -2,117 +2,11 @@
 /*
  *  linux/fs/locks.c
  *
- *  Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
- *  Doug Evans ([email protected]), August 07, 1992
+ * We implement four types of file locks: BSD locks, posix locks, open
+ * file description locks, and leases.  For details about BSD locks,
+ * see the flock(2) man page; for details about the other three, see
+ * fcntl(2).
  *
- *  Deadlock detection added.
- *  FIXME: one thing isn't handled yet:
- *	- mandatory locks (requires lots of changes elsewhere)
- *  Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
- *
- *  Miscellaneous edits, and a total rewrite of posix_lock_file() code.
- *  Kai Petzke ([email protected]), 1994
- *
- *  Converted file_lock_table to a linked list from an array, which eliminates
- *  the limits on how many active file locks are open.
- *  Chad Page ([email protected]), November 27, 1994
- *
- *  Removed dependency on file descriptors. dup()'ed file descriptors now
- *  get the same locks as the original file descriptors, and a close() on
- *  any file descriptor removes ALL the locks on the file for the current
- *  process. Since locks still depend on the process id, locks are inherited
- *  after an exec() but not after a fork(). This agrees with POSIX, and both
- *  BSD and SVR4 practice.
- *  Andy Walker ([email protected]), February 14, 1995
- *
- *  Scrapped free list which is redundant now that we allocate locks
- *  dynamically with kmalloc()/kfree().
- *  Andy Walker ([email protected]), February 21, 1995
- *
- *  Implemented two lock personalities - FL_FLOCK and FL_POSIX.
- *
- *  FL_POSIX locks are created with calls to fcntl() and lockf() through the
- *  fcntl() system call. They have the semantics described above.
- *
- *  FL_FLOCK locks are created with calls to flock(), through the flock()
- *  system call, which is new. Old C libraries implement flock() via fcntl()
- *  and will continue to use the old, broken implementation.
- *
- *  FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
- *  with a file pointer (filp). As a result they can be shared by a parent
- *  process and its children after a fork(). They are removed when the last
- *  file descriptor referring to the file pointer is closed (unless explicitly
- *  unlocked).
- *
- *  FL_FLOCK locks never deadlock, an existing lock is always removed before
- *  upgrading from shared to exclusive (or vice versa). When this happens
- *  any processes blocked by the current lock are woken up and allowed to
- *  run before the new lock is applied.
- *  Andy Walker ([email protected]), June 09, 1995
- *
- *  Removed some race conditions in flock_lock_file(), marked other possible
- *  races. Just grep for FIXME to see them.
- *  Dmitry Gorodchanin ([email protected]), February 09, 1996.
- *
- *  Addressed Dmitry's concerns. Deadlock checking no longer recursive.
- *  Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
- *  once we've checked for blocking and deadlocking.
- *  Andy Walker ([email protected]), April 03, 1996.
- *
- *  Initial implementation of mandatory locks. SunOS turned out to be
- *  a rotten model, so I implemented the "obvious" semantics.
- *  See 'Documentation/filesystems/mandatory-locking.rst' for details.
- *  Andy Walker ([email protected]), April 06, 1996.
- *
- *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to
- *  check if a file has mandatory locks, used by mmap(), open() and creat() to
- *  see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
- *  Manual, Section 2.
- *  Andy Walker ([email protected]), April 09, 1996.
- *
- *  Tidied up block list handling. Added '/proc/locks' interface.
- *  Andy Walker ([email protected]), April 24, 1996.
- *
- *  Fixed deadlock condition for pathological code that mixes calls to
- *  flock() and fcntl().
- *  Andy Walker ([email protected]), April 29, 1996.
- *
- *  Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
- *  for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
- *  guarantee sensible behaviour in the case where file system modules might
- *  be compiled with different options than the kernel itself.
- *  Andy Walker ([email protected]), May 15, 1996.
- *
- *  Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
- *  ([email protected]) for spotting this.
- *  Andy Walker ([email protected]), May 15, 1996.
- *
- *  Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
- *  locks. Changed process synchronisation to avoid dereferencing locks that
- *  have already been freed.
- *  Andy Walker ([email protected]), Sep 21, 1996.
- *
- *  Made the block list a circular list to minimise searching in the list.
- *  Andy Walker ([email protected]), Sep 25, 1996.
- *
- *  Made mandatory locking a mount option. Default is not to allow mandatory
- *  locking.
- *  Andy Walker ([email protected]), Oct 04, 1996.
- *
- *  Some adaptations for NFS support.
- *  Olaf Kirch ([email protected]), Dec 1996,
- *
- *  Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
- *  Andy Walker ([email protected]), May 12, 1997.
- *
- *  Use slab allocator instead of kmalloc/kfree.

Quoted 141 lines

From: "J. Bruce Fields" <[email protected]>

This is only of historical interest, and anyone interested in the history can dig out an old version of locks.c from from git.

Triggered by the observation that it references the now-removed Documentation/filesystems/mandatory-locking.rst.

Reported-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by J. Bruce Fields <[email protected]>

---
 fs/locks.c | 114 ++---------------------------------------------------
 1 file changed, 4 insertions(+), 110 deletions(-)

Quoted 2 lines · Jeff Layton

Yeah, I think that looks great. Send it with a changelog and I'll pull it into the branch I have feeding into -next.

OK!--b.

fs/locks.c +4 -108

index 3d6fb4ae847b..b54813eae44f 100644
@@ -2,117 +2,11 @@
 /*
  *  linux/fs/locks.c
  *
- *  Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
- *  Doug Evans ([email protected]), August 07, 1992
+ * We implement four types of file locks: BSD locks, posix locks, open
+ * file description locks, and leases.  For details about BSD locks,
+ * see the flock(2) man page; for details about the other three, see
+ * fcntl(2).
  *
- *  Deadlock detection added.
- *  FIXME: one thing isn't handled yet:
- *	- mandatory locks (requires lots of changes elsewhere)
- *  Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
- *
- *  Miscellaneous edits, and a total rewrite of posix_lock_file() code.
- *  Kai Petzke ([email protected]), 1994
- *
- *  Converted file_lock_table to a linked list from an array, which eliminates
- *  the limits on how many active file locks are open.
- *  Chad Page ([email protected]), November 27, 1994
- *
- *  Removed dependency on file descriptors. dup()'ed file descriptors now
- *  get the same locks as the original file descriptors, and a close() on
- *  any file descriptor removes ALL the locks on the file for the current
- *  process. Since locks still depend on the process id, locks are inherited
- *  after an exec() but not after a fork(). This agrees with POSIX, and both
- *  BSD and SVR4 practice.
- *  Andy Walker ([email protected]), February 14, 1995
- *
- *  Scrapped free list which is redundant now that we allocate locks
- *  dynamically with kmalloc()/kfree().
- *  Andy Walker ([email protected]), February 21, 1995
- *
- *  Implemented two lock personalities - FL_FLOCK and FL_POSIX.
- *
- *  FL_POSIX locks are created with calls to fcntl() and lockf() through the
- *  fcntl() system call. They have the semantics described above.
- *
- *  FL_FLOCK locks are created with calls to flock(), through the flock()
- *  system call, which is new. Old C libraries implement flock() via fcntl()
- *  and will continue to use the old, broken implementation.
- *
- *  FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
- *  with a file pointer (filp). As a result they can be shared by a parent
- *  process and its children after a fork(). They are removed when the last
- *  file descriptor referring to the file pointer is closed (unless explicitly
- *  unlocked).
- *
- *  FL_FLOCK locks never deadlock, an existing lock is always removed before
- *  upgrading from shared to exclusive (or vice versa). When this happens
- *  any processes blocked by the current lock are woken up and allowed to
- *  run before the new lock is applied.
- *  Andy Walker ([email protected]), June 09, 1995
- *
- *  Removed some race conditions in flock_lock_file(), marked other possible
- *  races. Just grep for FIXME to see them.
- *  Dmitry Gorodchanin ([email protected]), February 09, 1996.
- *
- *  Addressed Dmitry's concerns. Deadlock checking no longer recursive.
- *  Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
- *  once we've checked for blocking and deadlocking.
- *  Andy Walker ([email protected]), April 03, 1996.
- *
- *  Initial implementation of mandatory locks. SunOS turned out to be
- *  a rotten model, so I implemented the "obvious" semantics.
- *  See 'Documentation/filesystems/mandatory-locking.rst' for details.
- *  Andy Walker ([email protected]), April 06, 1996.
- *
- *  Don't allow mandatory locks on mmap()'ed files. Added simple functions to
- *  check if a file has mandatory locks, used by mmap(), open() and creat() to
- *  see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
- *  Manual, Section 2.
- *  Andy Walker ([email protected]), April 09, 1996.
- *
- *  Tidied up block list handling. Added '/proc/locks' interface.
- *  Andy Walker ([email protected]), April 24, 1996.
- *
- *  Fixed deadlock condition for pathological code that mixes calls to
- *  flock() and fcntl().
- *  Andy Walker ([email protected]), April 29, 1996.
- *
- *  Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
- *  for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
- *  guarantee sensible behaviour in the case where file system modules might
- *  be compiled with different options than the kernel itself.
- *  Andy Walker ([email protected]), May 15, 1996.
- *
- *  Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
- *  ([email protected]) for spotting this.
- *  Andy Walker ([email protected]), May 15, 1996.
- *
- *  Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
- *  locks. Changed process synchronisation to avoid dereferencing locks that
- *  have already been freed.
- *  Andy Walker ([email protected]), Sep 21, 1996.
- *
- *  Made the block list a circular list to minimise searching in the list.
- *  Andy Walker ([email protected]), Sep 25, 1996.
- *
- *  Made mandatory locking a mount option. Default is not to allow mandatory
- *  locking.
- *  Andy Walker ([email protected]), Oct 04, 1996.
- *
- *  Some adaptations for NFS support.
- *  Olaf Kirch ([email protected]), Dec 1996,
- *
- *  Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
- *  Andy Walker ([email protected]), May 12, 1997.
- *
- *  Use slab allocator instead of kmalloc/kfree.
- *  Use generic list implementation from <linux/list.h>.
- *  Sped up posix_locks_deadlock by only considering blocked locks.
- *  Matthew Wilcox <[email protected]>, March, 2000.
- *
- *  Leases and LOCK_MAND

fs/locks.c line 12

Quoted 5 lines

fs/locks.c +0 -2

- *  Matthew Wilcox <[email protected]>, June, 2000.
- *  Stephen Rothwell <[email protected]>, June, 2000.
  *
  * Locking conflicts and dependencies:
  * If multiple threads attempt to lock the same byte (or flock the same file)  

Thanks, Bruce (and Mauro). Applied to the locks-next branch (and I dropped Mauro's patch that touched the same area). It should make v5.16.

Cheers,

Changeset f38d3e404326 ("dt-bindings: mfd: Convert X-Powers AXP binding to a schema")
renamed: Documentation/devicetree/bindings/mfd/axp20x.txt
to: Documentation/devicetree/bindings/mfd/x-powers,axp152.yaml.

Update its cross-reference accordingly.

Fixes f38d3e404326 ("dt-bindings: mfd: Convert X-Powers AXP binding to a schema")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Changeset f38d3e404326 ("dt-bindings: mfd: Convert X-Powers AXP binding to a schema")
renamed: Documentation/devicetree/bindings/mfd/axp20x.txt
to: Documentation/devicetree/bindings/mfd/x-powers,axp152.yaml.

Update its cross-reference accordingly.

Fixes f38d3e404326 ("dt-bindings: mfd: Convert X-Powers AXP binding to a schema")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 Documentation/devicetree/bindings/gpio/gpio-axp209.txt | 2 +-

 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/devicetree/bindings/gpio/gpio-axp209.txt +1 -1

index fc42b2caa06d..538f04e60ff9 100644
@@ -17,7 +17,7 @@ Required properties:
 - gpio-controller: Marks the device node as a GPIO controller.
 
 This node must be a subnode of the axp20x PMIC, documented in
-Documentation/devicetree/bindings/mfd/axp20x.txt
+Documentation/devicetree/bindings/mfd/x-powers,axp152.yaml
 
 Example:
 

The file name: Documentation/devicetree/bindings/mfd/samsung,s2mpa01.yaml should be, instead: Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml.

Update its cross-reference accordingly.

Fixes a52afb0f54fa ("regulator: dt-bindings: samsung,s2mpa01: convert to dtschema")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 .../devicetree/bindings/regulator/samsung,s2mpa01.yaml          | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml +0 -0

index 0627dec513da..0a564319f4b2 100644

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

Quoted 3 lines

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

It'd be a bit easier to put a note in here about what the dependencies are rather than forcing people to go out to a link to figure out what's going on unless it's complicated.

For a case like this where there's no
dependencies or real relationship between the patches it's probably better to just not thread everything and send the patches separately to everyone, the threading is just adding noise and confusion.

Mark Brown <[email protected]> escreveu:

Quoted 4 lines

For a case like this where there's no
dependencies or real relationship between the patches it's probably better to just not thread everything and send the patches separately to everyone, the threading is just adding noise and confusion.

It is not that easy, unfortunately. On some cases (specially due to DT binding renames) some patches change the context of a hunk, affecting a subsequent patch.

I tried a couple of times in the past to send the patches individually, but that was messier, as there was harder for people to apply them, as, instead of running b4 just once to get everything, maintainers would need to apply each patch individually. Also, there were cases where the patch order would be relevant, due to context changes.

Em Tue, 19 Oct 2021 13:04:59 +0100
Mark Brown <[email protected]> escreveu:

Quoted 9 lines · Mauro Carvalho Chehab

Quoted 3 lines

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

It'd be a bit easier to put a note in here about what the dependencies are rather than forcing people to go out to a link to figure out what's going on unless it's complicated.

Quoted 4 lines

For a case like this where there's no
dependencies or real relationship between the patches it's probably better to just not thread everything and send the patches separately to everyone, the threading is just adding noise and confusion.

It is not that easy, unfortunately. On some cases (specially due to DT binding renames) some patches change the context of a hunk, affecting a subsequent patch.

I tried a couple of times in the past to send the patches individually, but that was messier, as there was harder for people to apply them, as, instead of running b4 just once to get everything, maintainers would need to apply each patch individually. Also, there were cases where the patch order would be relevant, due to context changes.

Btw, talking about what it would be easier, the best procedure to adopt is to run:

./scripts/documentation-file-ref-check

Before sending/applying patches touching documents.

That would avoid the need of such fixup patches ;-)

Unfortunately, in the specific case of dt-bindings, things are not that easy, as doc changes usually go via one tree, while references to them come from other places.

Regards,
Mauro

The file name: Documentation/devicetree/bindings/mfd/samsung,s5m8767.yaml should be, instead: Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml.

Update its cross-reference accordingly.

Fixes fab58debc137 ("regulator: dt-bindings: samsung,s5m8767: convert to dtschema")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 .../devicetree/bindings/regulator/samsung,s5m8767.yaml          | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml +0 -0

index 80a63d47790a..4281f670c775 100644

Changeset 89a5bf0f22fd ("dt-bindings: reserved-memory: ramoops: Convert txt bindings to yaml")
renamed: Documentation/devicetree/bindings/reserved-memory/ramoops.txt
to: Documentation/devicetree/bindings/reserved-memory/ramoops.yaml.

Update the cross-references accordingly.

Fixes 89a5bf0f22fd ("dt-bindings: reserved-memory: ramoops: Convert txt bindings to yaml")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 Documentation/admin-guide/ramoops.rst | 2 +-
 MAINTAINERS                           | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Documentation/admin-guide/ramoops.rst +0 -0

index 8f107d8c9261..e9f85142182d 100644
@@ -69,7 +69,7 @@ Setting the ramoops parameters can be done in 

several different manners:

Documentation/admin-guide/ramoops.rst +1 -1

 	mem=128M ramoops.mem_address=0x8000000 ramoops.ecc=1
 
  B. Use Device Tree bindings, as described in
- ``Documentation/devicetree/bindings/reserved-memory/ramoops.txt``.
+ ``Documentation/devicetree/bindings/reserved-memory/ramoops.yaml``.
  For example::
 
 	reserved-memory {

MAINTAINERS +0 -0

index d74b08c4fb1f..1dc758a0db58 100644
@@ -15336,7 +15336,7 @@ S:	Maintained
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git 

for-next/pstore
F: Documentation/admin-guide/ramoops.rst
F: Documentation/admin-guide/pstore-blk.rst

MAINTAINERS +1 -2

-F:	Documentation/devicetree/bindings/reserved-memory/ramoops.txt
+F:	Documentation/devicetree/bindings/reserved-memory/ramoops.yaml
 F:	drivers/acpi/apei/erst.c
 F:	drivers/firmware/efi/efi-pstore.c
 F:	fs/pstore/
--

2.31.1

Changeset 89a5bf0f22fd ("dt-bindings: reserved-memory: ramoops: Convert txt bindings to yaml")
renamed: Documentation/devicetree/bindings/reserved-memory/ramoops.txt
to: Documentation/devicetree/bindings/reserved-memory/ramoops.yaml.

Update the cross-references accordingly.

Fixes 89a5bf0f22fd ("dt-bindings: reserved-memory: ramoops: Convert txt bindings to yaml")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

To mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/23] at: https://lore.kernel.org/all/[email protected]/

 Documentation/admin-guide/ramoops.rst | 2 +-
 MAINTAINERS                           | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Hi Jon,

This series is against today's next (next-20211019) and addresses missing links to Documentation/*.

The best would be to have the patches applied directly to the trees that contain the patches that moved/renamed files, and then apply the remaining ones either later during the merge window or just afterwards, whatever works best for you.

Regards,
Mauro

Mauro Carvalho Chehab (23):
visorbus: fix a copyright symbol that was bad encoded
libbpf: update index.rst reference
docs: accounting: update delay-accounting.rst reference
MAINTAINERS: update arm,vic.yaml reference
MAINTAINERS: update aspeed,i2c.yaml reference
MAINTAINERS: update faraday,ftrtc010.yaml reference
MAINTAINERS: update ti,sci.yaml reference
MAINTAINERS: update intel,ixp46x-rng.yaml reference
MAINTAINERS: update nxp,imx8-jpeg.yaml reference
MAINTAINERS: update gemini.yaml reference
MAINTAINERS: update brcm,unimac-mdio.yaml reference
MAINTAINERS: update mtd-physmap.yaml reference

Documentation: update vcpu-requests.rst reference
bpftool: update bpftool-cgroup.rst reference
docs: translations: zn_CN: irq-affinity.rst: add a missing extension
docs: translations: zh_CN: memory-hotplug.rst: fix a typo
docs: fs: locks.rst: update comment about mandatory file locking
fs: remove a comment pointing to the removed mandatory-locking file Documentation/process: fix a cross reference
dt-bindings: mfd: update x-powers,axp152.yaml reference
regulator: dt-bindings: update samsung,s2mpa01.yaml reference
regulator: dt-bindings: update samsung,s5m8767.yaml reference
dt-bindings: reserved-memory: ramoops: update ramoops.yaml references