From mboxrd@z Thu Jan 1 00:00:00 1970 Date: Wed, 19 Jun 2019 07:22:18 -0300 From: Mauro Carvalho Chehab Subject: Re: [PATCH v1 12/22] docs: driver-api: add .rst files from the main dir Message-ID: <20190619072218.4437f891@coco.lan> In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit To: Daniel Vetter Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , Linux Kernel Mailing List , Jonathan Corbet , Johannes Berg , Kurt Schwemmer , Logan Gunthorpe , Bjorn Helgaas , Alan Stern , Andrea Parri , Will Deacon , Peter Zijlstra , Boqun Feng , Nicholas Piggin , David Howells , Jade Alglave , Luc Maranget , "Paul E. McKenney" , Akira Yokosawa , Daniel Lustig , Stuart Hayes , Thomas Gleixner , Ingo Molnar , Darren Hart , Kees Cook , Emese Revfy , Ohad Ben-Cohen , Bjorn Andersson , Corey Minyard , Marc Zyngier , William Breathitt Gray , Jaroslav Kysela , Greg Kroah-Hartman , "Rafael J. Wysocki" , "Naveen N. Rao" , Anil S Keshavamurthy , "David S. Miller" , Masami Hiramatsu , Johannes Thumshirn , Steffen Klassert , Sudip Mukherjee , Andreas =?UTF-8?B?RsOkcmJlcg==?= , Manivannan Sadhasivam , Rodolfo Giometti , Richard Cochran , Thierry Reding , Sumit Semwal , Gustavo Padovan , Jens Wiklander , Kirti Wankhede , Alex Williamson , Cornelia Huck , Bartlomiej Zolnierkiewicz , David Airlie , Maarten Lankhorst , Maxime Ripard , Sean Paul , Farhan Ali , Eric Farman , Halil Pasic , Heiko Carstens , Vasily Gorbik , Christian Borntraeger , Harry Wei , Alex Shi , Evgeniy Polyakov , Jerry Hoemann , Wim Van Sebroeck , Guenter Roeck , Guan Xuetao , Arnd Bergmann , Linus Walleij , Bartosz Golaszewski , Andy Shevchenko , Jiri Slaby , linux-wireless@vger.kernel.org, Linux PCI , "open list:GENERIC INCLUDE/A..." , platform-driver-x86@vger.kernel.org, Kernel Hardening , linux-remoteproc@vger.kernel.org, openipmi-developer@lists.sourceforge.net, linux-crypto@vger.kernel.org, Linux ARM , netdev , linux-pwm , dri-devel , kvm@vger.kernel.org, Linux Fbdev development list , linux-s390@vger.kernel.org, linux-watchdog@vger.kernel.org, "moderated list:DMA BUFFER SHARING FRAMEWORK" , linux-gpio , Linux MM List-ID: Hi Daniel, Em Wed, 19 Jun 2019 11:05:57 +0200 Daniel Vetter escreveu: > On Tue, Jun 18, 2019 at 10:55 PM Mauro Carvalho Chehab > wrote: > > diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst > > index fa30dfcfc3c8..b0f948d8733b 100644 > > --- a/Documentation/gpu/drm-mm.rst > > +++ b/Documentation/gpu/drm-mm.rst > > @@ -320,7 +320,7 @@ struct :c:type:`struct file_operations ` get_unmapped_area > > field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. > > > > More detailed information about get_unmapped_area can be found in > > -Documentation/nommu-mmap.rst > > +Documentation/driver-api/nommu-mmap.rst > > Random drive-by comment: Could we convert these into hyperlinks within > sphinx somehow, without making them less useful as raw file references > (with vim I can just type 'gf' and it works, emacs probably the same). > -Daniel Short answer: I don't know how vim/emacs would recognize Sphinx tags. There are two ways of doing hyperlinks to local files. The first one is to add a label at the other file and use a reference to such label, e. g. at nommu-mmap.rst, you would add a label like: .. _drm_nommu-mmap: at the beginning of the file. Then, at drm-mm.rst, you would use :ref:`drm_nommu-mmap` (there are a few other alternative tags that would work the same way). The advantage is that you could move/rename documents anytime, without needing to take care of it. Perhaps it could be possible a tool like cscope to parse those in order to provide such automation for Sphinx. I dunno. - The other way is to use: :doc:`nommu-mmap.rst` (if both files are at the same dir) The :doc: path is the current directory. So, if a file at, let's say, Documentation/gpu wants to refer another file at driver-api, it would need to write it as: :doc:`../driver-api/nommu-mmap.rst` I'm not sure if vim/emacs recognizes this syntax, though. Perhaps this tag could be used as: :doc:`Documentation/driver-api/nommu-mmap.rst <../driver-api/nommu-map.rst` But that looks too ugly to my taste. - On this conversion, I opted to not touch this. We may consider trying to replace those Thanks, Mauro From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Subject: Re: [PATCH v1 12/22] docs: driver-api: add .rst files from the main dir Date: Wed, 19 Jun 2019 07:22:18 -0300 Message-ID: <20190619072218.4437f891@coco.lan> References: Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: In-Reply-To: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Daniel Vetter Cc: Kernel Hardening , Farhan Ali , Will Deacon , dri-devel , Jaroslav Kysela , Evgeniy Polyakov , "open list:GENERIC INCLUDE/A..." , "Rafael J. Wysocki" , Halil Pasic , Alan Stern , Jiri Slaby , Guenter Roeck , Ohad Ben-Cohen , Marc Zyngier , Boqun Feng , Nicholas Piggin , Alex Williamson , Thomas Gleixner , Sean Paul , Greg Kroah-Hartman , linux-wireless@vger.kernel.org, Linux Kernel Mailing List l List-Id: linux-arch.vger.kernel.org SGkgRGFuaWVsLAoKRW0gV2VkLCAxOSBKdW4gMjAxOSAxMTowNTo1NyArMDIwMApEYW5pZWwgVmV0 dGVyIDxkYW5pZWxAZmZ3bGwuY2g+IGVzY3JldmV1OgoKPiBPbiBUdWUsIEp1biAxOCwgMjAxOSBh dCAxMDo1NSBQTSBNYXVybyBDYXJ2YWxobyBDaGVoYWIKPiA8bWNoZWhhYitzYW1zdW5nQGtlcm5l bC5vcmc+IHdyb3RlOgo+ID4gZGlmZiAtLWdpdCBhL0RvY3VtZW50YXRpb24vZ3B1L2RybS1tbS5y c3QgYi9Eb2N1bWVudGF0aW9uL2dwdS9kcm0tbW0ucnN0Cj4gPiBpbmRleCBmYTMwZGZjZmMzYzgu LmIwZjk0OGQ4NzMzYiAxMDA2NDQKPiA+IC0tLSBhL0RvY3VtZW50YXRpb24vZ3B1L2RybS1tbS5y c3QKPiA+ICsrKyBiL0RvY3VtZW50YXRpb24vZ3B1L2RybS1tbS5yc3QKPiA+IEBAIC0zMjAsNyAr MzIwLDcgQEAgc3RydWN0IDpjOnR5cGU6YHN0cnVjdCBmaWxlX29wZXJhdGlvbnMgPGZpbGVfb3Bl cmF0aW9ucz5gIGdldF91bm1hcHBlZF9hcmVhCj4gPiAgZmllbGQgd2l0aCBhIHBvaW50ZXIgb24g OmM6ZnVuYzpgZHJtX2dlbV9jbWFfZ2V0X3VubWFwcGVkX2FyZWFgLgo+ID4KPiA+ICBNb3JlIGRl dGFpbGVkIGluZm9ybWF0aW9uIGFib3V0IGdldF91bm1hcHBlZF9hcmVhIGNhbiBiZSBmb3VuZCBp bgo+ID4gLURvY3VtZW50YXRpb24vbm9tbXUtbW1hcC5yc3QKPiA+ICtEb2N1bWVudGF0aW9uL2Ry aXZlci1hcGkvbm9tbXUtbW1hcC5yc3QgIAo+IAo+IFJhbmRvbSBkcml2ZS1ieSBjb21tZW50OiBD b3VsZCB3ZSBjb252ZXJ0IHRoZXNlIGludG8gaHlwZXJsaW5rcyB3aXRoaW4KPiBzcGhpbnggc29t ZWhvdywgd2l0aG91dCBtYWtpbmcgdGhlbSBsZXNzIHVzZWZ1bCBhcyByYXcgZmlsZSByZWZlcmVu Y2VzCj4gKHdpdGggdmltIEkgY2FuIGp1c3QgdHlwZSAnZ2YnIGFuZCBpdCB3b3JrcywgZW1hY3Mg cHJvYmFibHkgdGhlIHNhbWUpLgo+IC1EYW5pZWwKClNob3J0IGFuc3dlcjogSSBkb24ndCBrbm93 IGhvdyB2aW0vZW1hY3Mgd291bGQgcmVjb2duaXplIFNwaGlueCB0YWdzLgoKVGhlcmUgYXJlIHR3 byB3YXlzIG9mIGRvaW5nIGh5cGVybGlua3MgdG8gbG9jYWwgZmlsZXMuIFRoZSBmaXJzdCBvbmUg aXMgdG8gCmFkZCBhIGxhYmVsIGF0IHRoZSBvdGhlciBmaWxlIGFuZCB1c2UgYSByZWZlcmVuY2Ug dG8gc3VjaCBsYWJlbCwgZS4gZy4gYXQKbm9tbXUtbW1hcC5yc3QsIHlvdSB3b3VsZCBhZGQgYSBs YWJlbCBsaWtlOgoKCS4uIF9kcm1fbm9tbXUtbW1hcDoKCmF0IHRoZSBiZWdpbm5pbmcgb2YgdGhl IGZpbGUuCgpUaGVuLCBhdCBkcm0tbW0ucnN0LCB5b3Ugd291bGQgdXNlIDpyZWY6YGRybV9ub21t dS1tbWFwYCAodGhlcmUgYXJlIGEKZmV3IG90aGVyIGFsdGVybmF0aXZlIHRhZ3MgdGhhdCB3b3Vs ZCB3b3JrIHRoZSBzYW1lIHdheSkuCgpUaGUgYWR2YW50YWdlIGlzIHRoYXQgeW91IGNvdWxkIG1v dmUvcmVuYW1lIGRvY3VtZW50cyBhbnl0aW1lLCB3aXRob3V0Cm5lZWRpbmcgdG8gdGFrZSBjYXJl IG9mIGl0LgoKUGVyaGFwcyBpdCBjb3VsZCBiZSBwb3NzaWJsZSBhIHRvb2wgbGlrZSBjc2NvcGUg dG8gcGFyc2UgdGhvc2UgaW4Kb3JkZXIgdG8gcHJvdmlkZSBzdWNoIGF1dG9tYXRpb24gZm9yIFNw aGlueC4gSSBkdW5uby4KCi0KClRoZSBvdGhlciB3YXkgaXMgdG8gdXNlOgoKCTpkb2M6YG5vbW11 LW1tYXAucnN0YCAoaWYgYm90aCBmaWxlcyBhcmUgYXQgdGhlIHNhbWUgZGlyKQoKVGhlIDpkb2M6 IHBhdGggaXMgdGhlIGN1cnJlbnQgZGlyZWN0b3J5LiBTbywgaWYgYSBmaWxlIGF0LCBsZXQncyBz YXksCkRvY3VtZW50YXRpb24vZ3B1IHdhbnRzIHRvIHJlZmVyIGFub3RoZXIgZmlsZSBhdCBkcml2 ZXItYXBpLCBpdCB3b3VsZApuZWVkIHRvIHdyaXRlIGl0IGFzOgoKCTpkb2M6YC4uL2RyaXZlci1h cGkvbm9tbXUtbW1hcC5yc3RgCgpJJ20gbm90IHN1cmUgaWYgdmltL2VtYWNzIHJlY29nbml6ZXMg dGhpcyBzeW50YXgsIHRob3VnaC4KClBlcmhhcHMgdGhpcyB0YWcgY291bGQgYmUgdXNlZCBhczoK Cgk6ZG9jOmBEb2N1bWVudGF0aW9uL2RyaXZlci1hcGkvbm9tbXUtbW1hcC5yc3QgPC4uL2RyaXZl ci1hcGkvbm9tbXUtbWFwLnJzdGAKCkJ1dCB0aGF0IGxvb2tzIHRvbyB1Z2x5IHRvIG15IHRhc3Rl LgoKLQoKT24gdGhpcyBjb252ZXJzaW9uLCBJIG9wdGVkIHRvIG5vdCB0b3VjaCB0aGlzLiBXZSBt YXkgY29uc2lkZXIgdHJ5aW5nCnRvIHJlcGxhY2UgdGhvc2UgCgoKVGhhbmtzLApNYXVybwpfX19f X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fXwpkcmktZGV2ZWwgbWFp bGluZyBsaXN0CmRyaS1kZXZlbEBsaXN0cy5mcmVlZGVza3RvcC5vcmcKaHR0cHM6Ly9saXN0cy5m cmVlZGVza3RvcC5vcmcvbWFpbG1hbi9saXN0aW5mby9kcmktZGV2ZWw=