[PATCH v2] Documentation/sphinx: Fix Directive import error
The sphinx.util.compat for Directive stuff was deprecated in the recent Sphinx version, and now we get a build error. Let's import from the new place, docutils.parsers.rst, while keeping the old sphinx.util.compat as fallback. Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694 Signed-off-by: Takashi Iwai <ti...@suse.de> --- v1->v2: Change the fallback order as Matthew suggested, the new one at first Documentation/sphinx/kerneldoc.py | 5 - 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py index 39aa9e8697cc..34396976eb0a 100644 --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -37,7 +37,10 @@ import glob from docutils import nodes, statemachine from docutils.statemachine import ViewList from docutils.parsers.rst import directives -from sphinx.util.compat import Directive +try: +from docutils.parsers.rst import directives, Directive +except ImportError: +from sphinx.util.compat import Directive from sphinx.ext.autodoc import AutodocReporter __version__ = '1.0' -- 2.16.2 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH] Documentation/sphinx: Fix Directive import error
On Fri, 02 Mar 2018 15:50:55 +0100, Matthew Wilcox wrote: > > On Fri, Mar 02, 2018 at 12:49:03PM +0100, Takashi Iwai wrote: > > I'm no expert of sphinx nor python, so something might be wrong. > > Please check it. > > I'm also not a pythonista, but ... > > > --- a/Documentation/sphinx/kerneldoc.py > > +++ b/Documentation/sphinx/kerneldoc.py > > @@ -37,7 +37,10 @@ import glob > > from docutils import nodes, statemachine > > from docutils.statemachine import ViewList > > from docutils.parsers.rst import directives > > -from sphinx.util.compat import Directive > > +try: > > +from sphinx.util.compat import Directive > > +except ImportError: > > +from docutils.parsers.rst import directives, Directive > > It seems to me the previous line already imported > docutils.parsers.rst.directives, and we should probably prefer the newer > parser even with Sphinx 1.6, so I would think this would work better: > > -from sphinx.util.compat import Directive > +try: > +from docutils.parsers.rst import Directive > +except ImportError: > +from sphinx.util.compat import Directive > > (it works on Debian with Sphinx 1.6.7) Makes more sense, yes. Jon, would you like me resending the patch? Or it's trivial enough as you can fix in place. thanks, Takashi -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: kernel-doc unbuildable with sphinx 1.7
On Fri, 02 Mar 2018 15:40:37 +0100, Jiri Slaby wrote: > > On 03/02/2018, 03:34 PM, Jonathan Corbet wrote: > > I got a patch from Takashi this very morning for that problem; I guess > > I'll have to fast-track it Linusward. > > Oh, thanks! > > P.S.: Takashi, could you push it to our master & stable branches? Sure, just waited for the feedback from Jon :) Takashi -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH] Documentation/sphinx: Fix Directive import error
The sphinx.util.compat Directive stuff was deprecated in the recent Sphinx version, and now we get a build error. Let's take a fallback to the newer one, from docutils.parsers.rst. Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694 Signed-off-by: Takashi Iwai <ti...@suse.de> --- I'm no expert of sphinx nor python, so something might be wrong. Please check it. --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -37,7 +37,10 @@ import glob from docutils import nodes, statemachine from docutils.statemachine import ViewList from docutils.parsers.rst import directives -from sphinx.util.compat import Directive +try: +from sphinx.util.compat import Directive +except ImportError: +from docutils.parsers.rst import directives, Directive from sphinx.ext.autodoc import AutodocReporter __version__ = '1.0' -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [alsa-devel] [PATCH v10 08/13] regmap: add SLIMbus support
On Thu, 14 Dec 2017 06:17:39 +0100, Vinod Koul wrote: > > On Wed, Dec 13, 2017 at 04:06:11PM +, Mark Brown wrote: > > > On Mon, Dec 11, 2017 at 11:43:02PM +, srinivas.kandaga...@linaro.org > > > wrote: > > > > > Mark, can I get an Ack for this patch so I can take it through my tree > > > with the other patches in this series? > > > > I'm actually not seeing a direct dependency here (there's a depends in > > place stopping the regmap code building if the Slimbus core isn't > > enabled) so if you want you can go ahead and apply the main stuff and I > > can apply the regmap change separately, it'll avoid Makefile/Kconfig > > conflicts anyway. > > + Takashi > > FWIW, since this is another MIPI Audio specfic bus, would it make sense for > this series to go thru sound/ tree? I have discussed with Takashi and Greg > for soundwire and we are taking sound path. > > Would that be okay here too? Either ways I dont mind :) Me too, I don't mind who takes what. Just let me know. thanks, Takashi -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 3/8] Documentation: fix input related doc refs
On Tue, 10 Oct 2017 19:36:23 +0200, Tom Saeger wrote: > > Make `input` document refs valid including: > - joystick > - joystick-parport > > Signed-off-by: Tom Saeger <tom.sae...@oracle.com> For the sound part: Reviewed-by: Takashi Iwai <ti...@suse.de> thanks, Takashi > --- > Documentation/admin-guide/kernel-parameters.txt | 10 +- > Documentation/hid/hiddev.txt| 2 +- > Documentation/input/devices/xpad.rst| 3 ++- > Documentation/sound/cards/joystick.rst | 2 +- > 4 files changed, 9 insertions(+), 8 deletions(-) > > diff --git a/Documentation/admin-guide/kernel-parameters.txt > b/Documentation/admin-guide/kernel-parameters.txt > index e857bbbc8575..411b41127eee 100644 > --- a/Documentation/admin-guide/kernel-parameters.txt > +++ b/Documentation/admin-guide/kernel-parameters.txt > @@ -314,7 +314,7 @@ > amijoy.map= [HW,JOY] Amiga joystick support > Map of devices attached to JOY0DAT and JOY1DAT > Format: , > - See also Documentation/input/joystick.txt > + See also Documentation/input/joydev/joystick.rst > > analog.map= [HW,JOY] Analog joystick and gamepad support > Specifies type or capabilities of an analog joystick > @@ -724,7 +724,7 @@ > db9.dev[2|3]= [HW,JOY] Multisystem joystick support via parallel port > (one device per port) > Format: <port#>, > - See also Documentation/input/joystick-parport.txt > + See also > Documentation/input/devices/joystick-parport.rst > > ddebug_query= [KNL,DYNAMIC_DEBUG] Enable debug messages at early boot > time. See > @@ -1220,7 +1220,7 @@ > [HW,JOY] Multisystem joystick and NES/SNES/PSX pad > support via parallel port (up to 5 devices per port) > Format: <port#>, > - See also Documentation/input/joystick-parport.txt > + See also > Documentation/input/devices/joystick-parport.rst > > gamma= [HW,DRM] > > @@ -1766,7 +1766,7 @@ > ivrs_acpihid[00:14.5]=AMD0020:0 > > js= [HW,JOY] Analog joystick > - See Documentation/input/joystick.txt. > + See Documentation/input/joydev/joystick.rst. > > nokaslr [KNL] > When CONFIG_RANDOMIZE_BASE is set, this disables > @@ -4199,7 +4199,7 @@ > TurboGraFX parallel port interface > Format: > <port#>,,, > - See also Documentation/input/joystick-parport.txt > + See also > Documentation/input/devices/joystick-parport.rst > > udbg-immortal [PPC] When debugging early kernel crashes that > happen after console_init() and before a proper > diff --git a/Documentation/hid/hiddev.txt b/Documentation/hid/hiddev.txt > index 6e8c9f1d2f22..638448707aa2 100644 > --- a/Documentation/hid/hiddev.txt > +++ b/Documentation/hid/hiddev.txt > @@ -12,7 +12,7 @@ To support these disparate requirements, the Linux USB > system provides > HID events to two separate interfaces: > * the input subsystem, which converts HID events into normal input > device interfaces (such as keyboard, mouse and joystick) and a > -normalised event interface - see Documentation/input/input.txt > +normalised event interface - see Documentation/input/input.rst > * the hiddev interface, which provides fairly raw HID events > > The data flow for a HID event produced by a device is something like > diff --git a/Documentation/input/devices/xpad.rst > b/Documentation/input/devices/xpad.rst > index 5a709ab77c8d..b8bd65962dd8 100644 > --- a/Documentation/input/devices/xpad.rst > +++ b/Documentation/input/devices/xpad.rst > @@ -230,4 +230,5 @@ Historic Edits > 2005-03-19 - Dominic Cerquetti <binary1...@yahoo.com> > - added stuff for dance pads, new d-pad->axes mappings > > -Later changes may be viewed with 'git log Documentation/input/xpad.txt' > +Later changes may be viewed with > +'git log --follow Documentation/input/devices/xpad.rst' > diff --git a/Documentation/sound/cards/joystick.rst > b/Documentation/sound/cards/joystick.rst > index a6e468c81d02..488946fc1079 100644 > --- a/Documentation/sound/cards/joystick.rst > +++ b/Documentation/sound/cards/joystick.rst > @@ -11,7 +11,7 @@ General > > First of all, you need to enable GAMEPORT s
Re: [PATCH 6/8] Documentation: fix sound related doc refs
On Tue, 10 Oct 2017 19:36:45 +0200, Tom Saeger wrote: > > Make sound doc refs valid. > > Signed-off-by: Tom Saeger <tom.sae...@oracle.com> Reviewed-by: Takashi Iwai <ti...@suse.de> thanks, Takashi > --- > Documentation/sound/hd-audio/notes.rst| 2 +- > Documentation/sound/kernel-api/writing-an-alsa-driver.rst | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/sound/hd-audio/notes.rst > b/Documentation/sound/hd-audio/notes.rst > index f59c3cdbfaf4..9f7347830ba4 100644 > --- a/Documentation/sound/hd-audio/notes.rst > +++ b/Documentation/sound/hd-audio/notes.rst > @@ -192,7 +192,7 @@ preset model instead of PCI (and codec-) SSID look-up. > What ``model`` option values are available depends on the codec chip. > Check your codec chip from the codec proc file (see "Codec Proc-File" > section below). It will show the vendor/product name of your codec > -chip. Then, see Documentation/sound/HD-Audio-Models.rst file, > +chip. Then, see Documentation/sound/hd-audio/models.rst file, > the section of HD-audio driver. You can find a list of codecs > and ``model`` options belonging to each codec. For example, for Realtek > ALC262 codec chip, pass ``model=ultra`` for devices that are compatible > diff --git a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst > b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst > index 58ffa3f5bda7..a0b268466cb1 100644 > --- a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst > +++ b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst > @@ -2498,7 +2498,7 @@ Mic boost > Mic-boost switch is set as “Mic Boost” or “Mic Boost (6dB)”. > > More precise information can be found in > -``Documentation/sound/alsa/ControlNames.txt``. > +``Documentation/sound/designs/control-names.rst``. > > Access Flags > > -- > 2.14.2 > > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v2 15/53] docs-rst: add sound book to pdf output
On Tue, 16 May 2017 14:16:07 +0200, Mauro Carvalho Chehab wrote: > > The sound subsystem book was added without the bits required to > generate PDF output. Add them. > > Signed-off-by: Mauro Carvalho Chehab <mche...@s-opensource.com> Looks good to me. Reviewed-by: Takashi Iwai <ti...@suse.de> thanks, Takashi > --- > Documentation/conf.py | 2 ++ > Documentation/sound/conf.py | 10 ++ > 2 files changed, 12 insertions(+) > create mode 100644 Documentation/sound/conf.py > > diff --git a/Documentation/conf.py b/Documentation/conf.py > index 1d461f0c1cd0..bca751960dec 100644 > --- a/Documentation/conf.py > +++ b/Documentation/conf.py > @@ -371,6 +371,8 @@ latex_documents = [ > 'The kernel development community', 'manual'), > ('security/index', 'security.tex', 'The kernel security subsystem > manual', > 'The kernel development community', 'manual'), > +('sound/index', 'sound.tex', 'Linux Sound Subsystem Documentation', > + 'The kernel development community', 'manual'), > ] > > # The name of an image file (relative to this directory) to place at the top > of > diff --git a/Documentation/sound/conf.py b/Documentation/sound/conf.py > new file mode 100644 > index ..3f1fc5e74e7b > --- /dev/null > +++ b/Documentation/sound/conf.py > @@ -0,0 +1,10 @@ > +# -*- coding: utf-8; mode: python -*- > + > +project = "Linux Sound Subsystem Documentation" > + > +tags.add("subproject") > + > +latex_documents = [ > +('index', 'sound.tex', project, > + 'The kernel development community', 'manual'), > +] > -- > 2.9.3 > > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 10/13] sound: fix the comments that refers to kernel-doc
On Tue, 16 May 2017 12:46:53 +0200, Mauro Carvalho Chehab wrote: > > Em Mon, 15 May 2017 11:04:26 +0200 > Takashi Iwai <ti...@suse.de> escreveu: > > > On Sun, 14 May 2017 17:38:44 +0200, > > Mauro Carvalho Chehab wrote: > > > > > > The markup inside the #if 0 comment actually refers to a > > > kernel-doc markup. As we're getting rid of DocBook update it. > > > > > > Signed-off-by: Mauro Carvalho Chehab <mche...@s-opensource.com> > > > > I guess you prefer taking it from your tree? Feel free to take my > > ack: > > Reviewed-by: Takashi Iwai <ti...@suse.de> > > In the specific case of this patch, it doesn't matter much from what > tree it would be merged, as no other patch depends on it ;) > > So, if you prefer, you can merge it directly on your tree. Otherwise, > I'll keep it on my pile of patches to be send to docs -next. OK, since the PCM stuff is being changed for 4.13, may be it's safer that I take this patch in sound git tree. thanks, Takashi > > > > > > > > thanks, > > > > Takashi > > > > > --- > > > include/sound/pcm.h | 2 +- > > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > > > diff --git a/include/sound/pcm.h b/include/sound/pcm.h > > > index 361749e60799..bbf97d4c4c17 100644 > > > --- a/include/sound/pcm.h > > > +++ b/include/sound/pcm.h > > > @@ -1054,7 +1054,7 @@ int snd_pcm_format_unsigned(snd_pcm_format_t > > > format); > > > int snd_pcm_format_linear(snd_pcm_format_t format); > > > int snd_pcm_format_little_endian(snd_pcm_format_t format); > > > int snd_pcm_format_big_endian(snd_pcm_format_t format); > > > -#if 0 /* just for DocBook */ > > > +#if 0 /* just for kernel-doc */ > > > /** > > > * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian > > > * @format: the format to check > > > -- > > > 2.9.3 > > > > > > > > > > Thanks, > Mauro > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 10/13] sound: fix the comments that refers to kernel-doc
On Sun, 14 May 2017 17:38:44 +0200, Mauro Carvalho Chehab wrote: > > The markup inside the #if 0 comment actually refers to a > kernel-doc markup. As we're getting rid of DocBook update it. > > Signed-off-by: Mauro Carvalho Chehab <mche...@s-opensource.com> I guess you prefer taking it from your tree? Feel free to take my ack: Reviewed-by: Takashi Iwai <ti...@suse.de> thanks, Takashi > --- > include/sound/pcm.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/sound/pcm.h b/include/sound/pcm.h > index 361749e60799..bbf97d4c4c17 100644 > --- a/include/sound/pcm.h > +++ b/include/sound/pcm.h > @@ -1054,7 +1054,7 @@ int snd_pcm_format_unsigned(snd_pcm_format_t format); > int snd_pcm_format_linear(snd_pcm_format_t format); > int snd_pcm_format_little_endian(snd_pcm_format_t format); > int snd_pcm_format_big_endian(snd_pcm_format_t format); > -#if 0 /* just for DocBook */ > +#if 0 /* just for kernel-doc */ > /** > * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian > * @format: the format to check > -- > 2.9.3 > > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v4 6/6] sound: replace /proc/bus/usb by /dev/bus/usb
On Mon, 17 Apr 2017 02:51:11 +0200, Mauro Carvalho Chehab wrote: > > The /proc/bus/usb devices don't exist anymore, since when we > got rid of usbfs. Those devices are now seen at > /dev/bus/usb. > > Signed-off-by: Mauro Carvalho ChehabSince it's a driver fix, I applied it to sound tree now. thanks, Takashi > --- > sound/usb/usx2y/us122l.c| 2 +- > sound/usb/usx2y/usX2Yhwdep.c| 2 +- > sound/usb/usx2y/usx2yhwdeppcm.c | 2 +- > 3 files changed, 3 insertions(+), 3 deletions(-) > > diff --git a/sound/usb/usx2y/us122l.c b/sound/usb/usx2y/us122l.c > index cf45bf1f7ee0..e118bdca983d 100644 > --- a/sound/usb/usx2y/us122l.c > +++ b/sound/usb/usx2y/us122l.c > @@ -472,7 +472,7 @@ static int usb_stream_hwdep_new(struct snd_card *card) > hw->ops.mmap = usb_stream_hwdep_mmap; > hw->ops.poll = usb_stream_hwdep_poll; > > - sprintf(hw->name, "/proc/bus/usb/%03d/%03d/hwdeppcm", > + sprintf(hw->name, "/dev/bus/usb/%03d/%03d/hwdeppcm", > dev->bus->busnum, dev->devnum); > return 0; > } > diff --git a/sound/usb/usx2y/usX2Yhwdep.c b/sound/usb/usx2y/usX2Yhwdep.c > index 605e1047c01d..f4b3cda412fc 100644 > --- a/sound/usb/usx2y/usX2Yhwdep.c > +++ b/sound/usb/usx2y/usX2Yhwdep.c > @@ -258,7 +258,7 @@ int usX2Y_hwdep_new(struct snd_card *card, struct > usb_device* device) > hw->ops.mmap = snd_us428ctls_mmap; > hw->ops.poll = snd_us428ctls_poll; > hw->exclusive = 1; > - sprintf(hw->name, "/proc/bus/usb/%03d/%03d", device->bus->busnum, > device->devnum); > + sprintf(hw->name, "/dev/bus/usb/%03d/%03d", device->bus->busnum, > device->devnum); > return 0; > } > > diff --git a/sound/usb/usx2y/usx2yhwdeppcm.c b/sound/usb/usx2y/usx2yhwdeppcm.c > index f95164b91152..d51c7fd7835b 100644 > --- a/sound/usb/usx2y/usx2yhwdeppcm.c > +++ b/sound/usb/usx2y/usx2yhwdeppcm.c > @@ -723,7 +723,7 @@ int usX2Y_hwdep_pcm_new(struct snd_card *card) > hw->ops.release = snd_usX2Y_hwdep_pcm_release; > hw->ops.mmap = snd_usX2Y_hwdep_pcm_mmap; > hw->exclusive = 1; > - sprintf(hw->name, "/proc/bus/usb/%03d/%03d/hwdeppcm", dev->bus->busnum, > dev->devnum); > + sprintf(hw->name, "/dev/bus/usb/%03d/%03d/hwdeppcm", dev->bus->busnum, > dev->devnum); > > err = snd_pcm_new(card, NAME_ALLCAPS" hwdep Audio", 2, 1, 1, ); > if (err < 0) { > -- > 2.9.3 > > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 36/41] Documentation: sound: fix spelling mistakes
On Mon, 25 Apr 2016 08:37:02 +0200, Eric Engestrom wrote: > > Signed-off-by: Eric EngestromApplied, thanks. Takashi -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html