diff mbox series

9pfs: add link to 9p developer docs

Message ID E1leeDf-0008GZ-9q@lizzy.crudebyte.com (mailing list archive)
State New, archived
Headers show
Series 9pfs: add link to 9p developer docs | expand

Commit Message

Christian Schoenebeck May 6, 2021, 1:12 p.m. UTC
To lower the entry level for new developers, add a link to the
9p developer docs (i.e. qemu wiki) at the beginning of 9p source
files, that is to: https://wiki.qemu.org/Documentation/9p

Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
---
 hw/9pfs/9p-local.c             | 5 +++++
 hw/9pfs/9p-posix-acl.c         | 5 +++++
 hw/9pfs/9p-proxy.c             | 5 +++++
 hw/9pfs/9p-synth.c             | 5 +++++
 hw/9pfs/9p-util.c              | 5 +++++
 hw/9pfs/9p-xattr-user.c        | 5 +++++
 hw/9pfs/9p-xattr.c             | 5 +++++
 hw/9pfs/9p.c                   | 5 +++++
 hw/9pfs/codir.c                | 5 +++++
 hw/9pfs/cofile.c               | 5 +++++
 hw/9pfs/cofs.c                 | 5 +++++
 hw/9pfs/coth.c                 | 5 +++++
 hw/9pfs/coxattr.c              | 5 +++++
 hw/9pfs/virtio-9p-device.c     | 5 +++++
 hw/9pfs/xen-9p-backend.c       | 5 +++++
 tests/qtest/libqos/virtio-9p.c | 5 +++++
 tests/qtest/virtio-9p-test.c   | 5 +++++
 17 files changed, 85 insertions(+)

Comments

Connor Kuehl May 11, 2021, 7:57 p.m. UTC | #1
On 5/6/21 8:12 AM, Christian Schoenebeck wrote:
> To lower the entry level for new developers, add a link to the
> 9p developer docs (i.e. qemu wiki) at the beginning of 9p source
> files, that is to: https://wiki.qemu.org/Documentation/9p
> 
> Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
> ---
>  hw/9pfs/9p-local.c             | 5 +++++
>  hw/9pfs/9p-posix-acl.c         | 5 +++++
>  hw/9pfs/9p-proxy.c             | 5 +++++
>  hw/9pfs/9p-synth.c             | 5 +++++
>  hw/9pfs/9p-util.c              | 5 +++++
>  hw/9pfs/9p-xattr-user.c        | 5 +++++
>  hw/9pfs/9p-xattr.c             | 5 +++++
>  hw/9pfs/9p.c                   | 5 +++++
>  hw/9pfs/codir.c                | 5 +++++
>  hw/9pfs/cofile.c               | 5 +++++
>  hw/9pfs/cofs.c                 | 5 +++++
>  hw/9pfs/coth.c                 | 5 +++++
>  hw/9pfs/coxattr.c              | 5 +++++
>  hw/9pfs/virtio-9p-device.c     | 5 +++++
>  hw/9pfs/xen-9p-backend.c       | 5 +++++
>  tests/qtest/libqos/virtio-9p.c | 5 +++++
>  tests/qtest/virtio-9p-test.c   | 5 +++++

Would it be helpful to also add this link to the virtio-9p stanza in
MAINTAINERS? Something like:

W: https://wiki.qemu.org/Documentation/9p

Connor
Christian Schoenebeck May 12, 2021, 10:25 a.m. UTC | #2
On Dienstag, 11. Mai 2021 21:57:53 CEST Connor Kuehl wrote:
> On 5/6/21 8:12 AM, Christian Schoenebeck wrote:
> > To lower the entry level for new developers, add a link to the
> > 9p developer docs (i.e. qemu wiki) at the beginning of 9p source
> > files, that is to: https://wiki.qemu.org/Documentation/9p
> > 
> > Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
> > ---
> > 
> >  hw/9pfs/9p-local.c             | 5 +++++
> >  hw/9pfs/9p-posix-acl.c         | 5 +++++
> >  hw/9pfs/9p-proxy.c             | 5 +++++
> >  hw/9pfs/9p-synth.c             | 5 +++++
> >  hw/9pfs/9p-util.c              | 5 +++++
> >  hw/9pfs/9p-xattr-user.c        | 5 +++++
> >  hw/9pfs/9p-xattr.c             | 5 +++++
> >  hw/9pfs/9p.c                   | 5 +++++
> >  hw/9pfs/codir.c                | 5 +++++
> >  hw/9pfs/cofile.c               | 5 +++++
> >  hw/9pfs/cofs.c                 | 5 +++++
> >  hw/9pfs/coth.c                 | 5 +++++
> >  hw/9pfs/coxattr.c              | 5 +++++
> >  hw/9pfs/virtio-9p-device.c     | 5 +++++
> >  hw/9pfs/xen-9p-backend.c       | 5 +++++
> >  tests/qtest/libqos/virtio-9p.c | 5 +++++
> >  tests/qtest/virtio-9p-test.c   | 5 +++++
> 
> Would it be helpful to also add this link to the virtio-9p stanza in
> MAINTAINERS? Something like:
> 
> W: https://wiki.qemu.org/Documentation/9p
> 
> Connor

Right, makes sense to me. I think I can just handle that as a separate patch 
subsequently, not worth a threaded V2 IMO.

@Greg: a humble PING from the silent 9p front.

Best regards,
Christian Schoenebeck
Greg Kurz May 12, 2021, 12:39 p.m. UTC | #3
On Wed, 12 May 2021 12:25:56 +0200
Christian Schoenebeck <qemu_oss@crudebyte.com> wrote:

> On Dienstag, 11. Mai 2021 21:57:53 CEST Connor Kuehl wrote:
> > On 5/6/21 8:12 AM, Christian Schoenebeck wrote:
> > > To lower the entry level for new developers, add a link to the
> > > 9p developer docs (i.e. qemu wiki) at the beginning of 9p source
> > > files, that is to: https://wiki.qemu.org/Documentation/9p
> > > 
> > > Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
> > > ---
> > > 
> > >  hw/9pfs/9p-local.c             | 5 +++++
> > >  hw/9pfs/9p-posix-acl.c         | 5 +++++
> > >  hw/9pfs/9p-proxy.c             | 5 +++++
> > >  hw/9pfs/9p-synth.c             | 5 +++++
> > >  hw/9pfs/9p-util.c              | 5 +++++
> > >  hw/9pfs/9p-xattr-user.c        | 5 +++++
> > >  hw/9pfs/9p-xattr.c             | 5 +++++
> > >  hw/9pfs/9p.c                   | 5 +++++
> > >  hw/9pfs/codir.c                | 5 +++++
> > >  hw/9pfs/cofile.c               | 5 +++++
> > >  hw/9pfs/cofs.c                 | 5 +++++
> > >  hw/9pfs/coth.c                 | 5 +++++
> > >  hw/9pfs/coxattr.c              | 5 +++++
> > >  hw/9pfs/virtio-9p-device.c     | 5 +++++
> > >  hw/9pfs/xen-9p-backend.c       | 5 +++++
> > >  tests/qtest/libqos/virtio-9p.c | 5 +++++
> > >  tests/qtest/virtio-9p-test.c   | 5 +++++
> > 
> > Would it be helpful to also add this link to the virtio-9p stanza in
> > MAINTAINERS? Something like:
> > 
> > W: https://wiki.qemu.org/Documentation/9p
> > 
> > Connor
> 
> Right, makes sense to me. I think I can just handle that as a separate patch 
> subsequently, not worth a threaded V2 IMO.
> 
> @Greg: a humble PING from the silent 9p front.
> 

Sorry for lack of care... I agree both with the patch and with
Connor's suggestion. No need to even post anything more. You
can just fix this patch in your tree.

Acked-by: Greg Kurz <groug@kaod.org>

> Best regards,
> Christian Schoenebeck
> 
>
Christian Schoenebeck May 12, 2021, 2 p.m. UTC | #4
On Mittwoch, 12. Mai 2021 14:39:06 CEST Greg Kurz wrote:
> On Wed, 12 May 2021 12:25:56 +0200
> 
> Christian Schoenebeck <qemu_oss@crudebyte.com> wrote:
> > On Dienstag, 11. Mai 2021 21:57:53 CEST Connor Kuehl wrote:
> > > On 5/6/21 8:12 AM, Christian Schoenebeck wrote:
> > > > To lower the entry level for new developers, add a link to the
> > > > 9p developer docs (i.e. qemu wiki) at the beginning of 9p source
> > > > files, that is to: https://wiki.qemu.org/Documentation/9p
> > > > 
> > > > Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
> > > > ---
> > > > 
> > > >  hw/9pfs/9p-local.c             | 5 +++++
> > > >  hw/9pfs/9p-posix-acl.c         | 5 +++++
> > > >  hw/9pfs/9p-proxy.c             | 5 +++++
> > > >  hw/9pfs/9p-synth.c             | 5 +++++
> > > >  hw/9pfs/9p-util.c              | 5 +++++
> > > >  hw/9pfs/9p-xattr-user.c        | 5 +++++
> > > >  hw/9pfs/9p-xattr.c             | 5 +++++
> > > >  hw/9pfs/9p.c                   | 5 +++++
> > > >  hw/9pfs/codir.c                | 5 +++++
> > > >  hw/9pfs/cofile.c               | 5 +++++
> > > >  hw/9pfs/cofs.c                 | 5 +++++
> > > >  hw/9pfs/coth.c                 | 5 +++++
> > > >  hw/9pfs/coxattr.c              | 5 +++++
> > > >  hw/9pfs/virtio-9p-device.c     | 5 +++++
> > > >  hw/9pfs/xen-9p-backend.c       | 5 +++++
> > > >  tests/qtest/libqos/virtio-9p.c | 5 +++++
> > > >  tests/qtest/virtio-9p-test.c   | 5 +++++
> > > 
> > > Would it be helpful to also add this link to the virtio-9p stanza in
> > > MAINTAINERS? Something like:
> > > 
> > > W: https://wiki.qemu.org/Documentation/9p
> > > 
> > > Connor
> > 
> > Right, makes sense to me. I think I can just handle that as a separate
> > patch subsequently, not worth a threaded V2 IMO.
> > 
> > @Greg: a humble PING from the silent 9p front.
> 
> Sorry for lack of care... I agree both with the patch and with
> Connor's suggestion. No need to even post anything more. You
> can just fix this patch in your tree.
> 
> Acked-by: Greg Kurz <groug@kaod.org>
> 

Queued. Thanks! 

https://github.com/cschoenebeck/qemu/commits/9p.next

Best regards,
Christian Schoenebeck
diff mbox series

Patch

diff --git a/hw/9pfs/9p-local.c b/hw/9pfs/9p-local.c
index af52c1daac..210d9e7705 100644
--- a/hw/9pfs/9p-local.c
+++ b/hw/9pfs/9p-local.c
@@ -10,6 +10,11 @@ 
  * the COPYING file in the top-level directory.
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "9p.h"
 #include "9p-local.h"
diff --git a/hw/9pfs/9p-posix-acl.c b/hw/9pfs/9p-posix-acl.c
index bbf89064f7..eadae270dd 100644
--- a/hw/9pfs/9p-posix-acl.c
+++ b/hw/9pfs/9p-posix-acl.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "qemu/xattr.h"
 #include "9p.h"
diff --git a/hw/9pfs/9p-proxy.c b/hw/9pfs/9p-proxy.c
index 4aa4e0a3ba..09bd9f1464 100644
--- a/hw/9pfs/9p-proxy.c
+++ b/hw/9pfs/9p-proxy.c
@@ -10,6 +10,11 @@ 
  * the COPYING file in the top-level directory.
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include <sys/socket.h>
 #include <sys/un.h>
diff --git a/hw/9pfs/9p-synth.c b/hw/9pfs/9p-synth.c
index 473ef914b0..b38088e066 100644
--- a/hw/9pfs/9p-synth.c
+++ b/hw/9pfs/9p-synth.c
@@ -12,6 +12,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "9p.h"
 #include "fsdev/qemu-fsdev.h"
diff --git a/hw/9pfs/9p-util.c b/hw/9pfs/9p-util.c
index 614b7fc34d..3221d9b498 100644
--- a/hw/9pfs/9p-util.c
+++ b/hw/9pfs/9p-util.c
@@ -10,6 +10,11 @@ 
  * See the COPYING file in the top-level directory.
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "qemu/xattr.h"
 #include "9p-util.h"
diff --git a/hw/9pfs/9p-xattr-user.c b/hw/9pfs/9p-xattr-user.c
index 2c90817b75..f2ae9582e6 100644
--- a/hw/9pfs/9p-xattr-user.c
+++ b/hw/9pfs/9p-xattr-user.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "9p.h"
 #include "fsdev/file-op-9p.h"
diff --git a/hw/9pfs/9p-xattr.c b/hw/9pfs/9p-xattr.c
index c696d8f846..9ae69dd8db 100644
--- a/hw/9pfs/9p-xattr.c
+++ b/hw/9pfs/9p-xattr.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "9p.h"
 #include "fsdev/file-op-9p.h"
diff --git a/hw/9pfs/9p.c b/hw/9pfs/9p.c
index 134806db52..0fa776af09 100644
--- a/hw/9pfs/9p.c
+++ b/hw/9pfs/9p.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include <glib/gprintf.h>
 #include "hw/virtio/virtio.h"
diff --git a/hw/9pfs/codir.c b/hw/9pfs/codir.c
index 1f70a58df5..032cce04c4 100644
--- a/hw/9pfs/codir.c
+++ b/hw/9pfs/codir.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "fsdev/qemu-fsdev.h"
 #include "qemu/thread.h"
diff --git a/hw/9pfs/cofile.c b/hw/9pfs/cofile.c
index 83bb6c14e0..20f93a90e7 100644
--- a/hw/9pfs/cofile.c
+++ b/hw/9pfs/cofile.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "fsdev/qemu-fsdev.h"
 #include "qemu/thread.h"
diff --git a/hw/9pfs/cofs.c b/hw/9pfs/cofs.c
index 0b321b456e..9d0adc2e78 100644
--- a/hw/9pfs/cofs.c
+++ b/hw/9pfs/cofs.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "fsdev/qemu-fsdev.h"
 #include "qemu/thread.h"
diff --git a/hw/9pfs/coth.c b/hw/9pfs/coth.c
index 9778f24b00..2802d41cce 100644
--- a/hw/9pfs/coth.c
+++ b/hw/9pfs/coth.c
@@ -12,6 +12,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "block/thread-pool.h"
 #include "qemu/coroutine.h"
diff --git a/hw/9pfs/coxattr.c b/hw/9pfs/coxattr.c
index 0e00ffaa0d..dbcd09e0fd 100644
--- a/hw/9pfs/coxattr.c
+++ b/hw/9pfs/coxattr.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "fsdev/qemu-fsdev.h"
 #include "qemu/thread.h"
diff --git a/hw/9pfs/virtio-9p-device.c b/hw/9pfs/virtio-9p-device.c
index 14371a78ef..54ee93b71f 100644
--- a/hw/9pfs/virtio-9p-device.c
+++ b/hw/9pfs/virtio-9p-device.c
@@ -11,6 +11,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "hw/virtio/virtio.h"
 #include "qemu/sockets.h"
diff --git a/hw/9pfs/xen-9p-backend.c b/hw/9pfs/xen-9p-backend.c
index a969fcc54c..65c4979c3c 100644
--- a/hw/9pfs/xen-9p-backend.c
+++ b/hw/9pfs/xen-9p-backend.c
@@ -8,6 +8,11 @@ 
  *
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 
 #include "hw/9pfs/9p.h"
diff --git a/tests/qtest/libqos/virtio-9p.c b/tests/qtest/libqos/virtio-9p.c
index be91662c6f..b4e1143288 100644
--- a/tests/qtest/libqos/virtio-9p.c
+++ b/tests/qtest/libqos/virtio-9p.c
@@ -16,6 +16,11 @@ 
  * License along with this library; if not, see <http://www.gnu.org/licenses/>
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "libqtest.h"
 #include "qemu/module.h"
diff --git a/tests/qtest/virtio-9p-test.c b/tests/qtest/virtio-9p-test.c
index 92a498f249..41fed41de1 100644
--- a/tests/qtest/virtio-9p-test.c
+++ b/tests/qtest/virtio-9p-test.c
@@ -7,6 +7,11 @@ 
  * See the COPYING file in the top-level directory.
  */
 
+/*
+ * Not so fast! You might want to read the 9p developer docs first:
+ * https://wiki.qemu.org/Documentation/9p
+ */
+
 #include "qemu/osdep.h"
 #include "libqtest-single.h"
 #include "qemu/module.h"