28 Jul, 2011

3 commits

  • The patch utility doesn't work with non-binary files. This causes some
    tools to break, like generating tarball targets and the scripts that
    generate diff patches at http://www.kernel.org/pub/linux/kernel/v2.6/.

    So, let's convert all binaries to ascii using base64, and add a
    logic at Makefile to convert them back into binaries at runtime.

    Reported-by: Randy Dunlap
    Reported-by: Andrew Morton
    Reviewed-by: Michal Marek
    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     
  • This patch addresses several issues pointed by Randy Dunlap
    at changeset ece722c:

    - In the generated index.html file, "media" is listed first, but it
    should be listed in alphabetical order, not first.

    - The generated files are (hidden) in .tmpmedia/

    - The link from the top-level index.html file to "media" is to
    media/index.html, but the file is actually in .tmpmedia/media/index.html

    - Please build docs with and without using "O=builddir" and test that.

    - Would it be possible for media to have its own Makefile instead of
    merging into this one?

    Due to the way cleandocs target works, I had to rename the media DocBook
    to media_api, otherwise cleandocs would remove the /media directory.

    Thanks-to: Randy Dunlap
    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     
  • Auto-generate the videodev2.h.xml,frontend.h.xml and the indexes.

    Some logic at the Makefile helps us to identify when a symbol is missing,
    like for example:

    Error: no ID for constraint linkend: V4L2-PIX-FMT-JPGL.

    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     

03 May, 2011

1 commit


28 Mar, 2011

1 commit

  • DocBook/v4l/ no longer has any *.png files, so the 'cp' command fails,
    breaking the build. Drop the *.png cp.

    cp: cannot stat `linux-2.6.38-git18/Documentation/DocBook/v4l/*.png': No such file or directory

    Signed-off-by: Randy Dunlap
    Signed-off-by: Linus Torvalds

    Randy Dunlap
     

22 Mar, 2011

1 commit

  • Add a userspace API to get, set and enumerate the media format on a
    subdev pad.

    The format at the output of a subdev usually depends on the format at
    its input(s). The try format operation is thus not suitable for probing
    format at individual pads, as it can't modify the device state and thus
    can't remember the format tried at the input to compute the output
    format.

    To fix the problem, pass an extra argument to the get/set format
    operations to select the 'try' or 'active' format.

    The try format is used when probing the subdev. Setting the try format
    must not change the device configuration but can store data for later
    reuse. Data storage is provided at the file-handle level so applications
    probing the subdev concurently won't interfere with each other.

    The active format is used when configuring the subdev. It's identical to
    the format handled by the usual get/set operations.

    Signed-off-by: Laurent Pinchart
    Signed-off-by: Stanimir Varbanov
    Signed-off-by: Sakari Ailus
    Acked-by: Hans Verkuil
    Signed-off-by: Mauro Carvalho Chehab

    Laurent Pinchart
     

26 Aug, 2010

1 commit


25 Aug, 2010

1 commit

  • This moves mac80211 documentation into a new
    802.11 bookset and also adds a cfg80211 book
    to the set. All of this is rather incomplete,
    but it's easier to work with big code moving
    as a separate patch.

    Signed-off-by: Johannes Berg
    Signed-off-by: John W. Linville

    Johannes Berg
     

11 Aug, 2010

2 commits

  • $ rm -rf build
    $ mkdir build
    $ cp .config build
    $ make O=build htmldocs
    ...
    xmlto: linux-2.6/build/Documentation/DocBook/media.xml
    does not validate (status 3)
    xmlto: Fix document syntax or use --skip-validation option
    linux-2.6/build/Documentation/DocBook/media.xml:4:
    warning: failed to load external entity
    "linux-2.6/build/Documentation/DocBook/media-entities.tmpl"

    We need the xmldoclinks built for any document types built from the
    XML sources.

    Signed-off-by: Ben Hutchings
    Acked-by: Andy Whitcroft
    Cc: Randy Dunlap
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Ben Hutchings
     
  • 'make htmldocs' produces errors due to missing a supporting media
    file, so add 'xmldoclinks' to the htmldocs dependencies so that the
    needed supporting file will be present.

    Documentation/DocBook/media.xml:4: warning: failed to load external entity "Documentation/DocBook/media-entities.tmpl"

    Signed-off-by: Randy Dunlap
    Acked-by: Mauro Carvalho Chehab
    Signed-off-by: Linus Torvalds

    Randy Dunlap
     

21 Apr, 2010

1 commit

  • Add a DRM DocBook providing basic information about DRM interfaces, including
    TTM, GEM, KMS and vblank infrastructure. Intended to provide information to
    new and existing developers about how to perform driver initialization,
    implement mode setting and other DRM features.

    Signed-off-by: Jesse Barnes
    Signed-off-by: Dave Airlie

    Jesse Barnes
     

17 Dec, 2009

1 commit

  • * 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-2.6: (116 commits)
    V4L/DVB (13698): pms: replace asm/uaccess.h to linux/uaccess.h
    V4L/DVB (13690): radio/si470x: #include
    V4L/DVB (13688): au8522: modify the attributes of local filter coefficients
    V4L/DVB (13687): cx231xx: use NULL when pointer is needed
    V4L/DVB: Davinci VPFE Capture: remove unused #include
    V4L/DVB (13685): Correct code taking the size of a pointer
    V4L/DVB (13684): Fix some cut-and-paste noise in dib0090.h
    V4L/DVB (13683): sanio-ms: clean up init, exit and id_table
    V4L/DVB (13682): dib8000: make some constant static
    V4L/DVB: lgs8gxx: Use shifts rather than multiply/divide when possible
    V4L/DVB (13680b): DocBook/media: create links for included sources
    V4L/DVB (13680a): DocBook/media: copy images after building HTML
    V4L/DVB (13678): Add support for yet another DvbWorld, TeVii and Prof USB devices
    V4L/DVB (13676): configurable IRQ mode on NetUP Dual DVB-S2 CI; IRQ from CAM processing (CI interface works faster)
    V4L/DVB (13674): stv090x: Add DiSEqC envelope mode
    V4L/DVB (13673): lnbp21: Implement 22 kHz tone control
    V4L/DVB (13671): sh_mobile_ceu_camera: Remove frame size page alignment
    V4L/DVB (13670): soc-camera: Add mt9t112 camera driver
    V4L/DVB (13669): tw9910: Add sync polarity support
    V4L/DVB (13668): tw9910: remove cropping
    ...

    Linus Torvalds
     

16 Dec, 2009

3 commits

  • Example is outdated, it still uses old ->read_proc interfaces and "fb"
    example is plain racy. There are better examples all over the tree.

    Docbook itself says almost nothing about /proc and contain quite a number
    of simply wrong facts, e.g. device nodes support. What it does is
    describing at great length interface which are going to be removed.

    There are Documentation/filesystems/seq_file.txt in exchange.

    Signed-off-by: Alexey Dobriyan
    Acked-by: Erik Mouw
    Cc: Randy Dunlap
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Alexey Dobriyan
     
  • If docs are being built in a separate directory, xmlto and xsltproc
    can't find included sources. Make links back to the source directory.

    I would much prefer to have xmlto and xsltproc look in the source
    directory for included entities but couldn't see how to do that. This
    needs to be solved in some way for 2.6.32, even if this patch isn't the
    right way to do it.

    Signed-off-by: Ben Hutchings
    Signed-off-by: Mauro Carvalho Chehab

    Ben Hutchings
     
  • The rule for %.html removes the output directory, so there is no point
    in copying images before building HTML.

    Documentation/DocBook/Makefile | 10 +++++-----

    Signed-off-by: Ben Hutchings
    Signed-off-by: Mauro Carvalho Chehab

    Ben Hutchings
     

19 Sep, 2009

2 commits


07 May, 2009

1 commit


01 May, 2009

2 commits

  • Add tracepoint docbook. This will help us document and understand
    what tracepoints are in the kernel. Since there are multiple
    macros, and files that contain tracepoints.

    [ Impact: add documentation ]

    Signed-off-by: Jason Baron
    Acked-by: Randy Dunlap
    Cc: akpm@linux-foundation.org
    Cc: rostedt@goodmis.org
    Cc: fweisbec@gmail.com
    Cc: mathieu.desnoyers@polymtl.ca
    Cc: wcohen@redhat.com
    LKML-Reference:
    Signed-off-by: Ingo Molnar

    Jason Baron
     
  • Missed index.html in "make cleandocs", so add it.

    Signed-off-by: Randy Dunlap
    Signed-off-by: Sam Ravnborg

    Randy Dunlap
     

11 Apr, 2009

1 commit


09 Mar, 2009

1 commit

  • Move ALSA docbooks to be with the rest of the kernel docbooks and add
    them to the Makefile so that they build. Latter required a few minor
    changes to alsa .tmpl files.
    (I did not remove all of the trailing whitespace in the .tmpl files.)

    Fixes kernel bugzilla #12726: http://bugzilla.kernel.org/show_bug.cgi?id=12726

    Signed-off-by: Randy Dunlap
    Cc: documentation_man-pages@kernel-bugs.osdl.org
    Cc: Nicola Soranzo
    Signed-off-by: Takashi Iwai

    Randy Dunlap
     

23 Feb, 2009

1 commit

  • The kernel-api docbook was much larger than any of the others,
    so processing it took longer and needed some docbook extras in
    some cases, so split it into kernel-api (infrastructure etc.)
    and device drivers/device subsystems. This allows these docbooks
    to be generated in parallel. (This reduced the docbook processing
    time on my 4-proc system with make -j4 from about 5min:16sec to
    about 2min:01sec.)

    The chapters that were moved from kernel-api to device-drivers are:

    Driver Basics
    Device drivers infrastructure
    Parallel Port Devices
    Message-based devices
    Sound Devices
    16x50 UART Driver
    Frame Buffer Library
    Input Subsystem
    Serial Peripheral Interface (SPI)
    I2C and SMBus Subsystem

    Signed-off-by: Randy Dunlap
    Acked-by: Sam Ravnborg
    Signed-off-by: Linus Torvalds

    Randy Dunlap
     

09 Jan, 2009

1 commit

  • Add a basic DocBook manual for the regulator API. This is much more
    skeletal than the existing text documentation, the main benefit is to
    provide a skeleton for automatic generation of a manual based on the
    kerneldoc for the API.

    Since large portions of the text are lifted from the existing text format
    documentation written by Liam Girdwood much of the credit belongs to
    him.

    Signed-off-by: Mark Brown
    Signed-off-by: Liam Girdwood

    Mark Brown
     

22 Nov, 2008

1 commit


31 Oct, 2008

1 commit

  • The total width of the command name plus spaces should be
    8 characters, but were 7 and 9, respectively. With 8 chars,
    all commands are now lining up nicely.

    The mandocs, psdocs, xmldocs commands are OK.

    Before:
    HOSTCC scripts/basic/docproc
    DOCPROC Documentation/DocBook/deviceiobook.xml
    HTML Documentation/DocBook/deviceiobook.html
    DOCPROC Documentation/DocBook/wanbook.xml
    PDF Documentation/DocBook/wanbook.pdf

    After:
    HOSTCC scripts/basic/docproc
    DOCPROC Documentation/DocBook/deviceiobook.xml
    HTML Documentation/DocBook/deviceiobook.html
    DOCPROC Documentation/DocBook/wanbook.xml
    PDF Documentation/DocBook/wanbook.pdf

    Signed-off-by: Hans Ulrich Niedermann
    Signed-off-by: Randy Dunlap
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Hans Ulrich Niedermann
     

17 Oct, 2008

1 commit

  • This document describes the long-deprecated V4L1 interface. In-tree, it
    can only serve to encourage developers to write drivers to the wrong API.
    Remove it in favor of the V4L2 documentation which must surely show up
    someday.

    Acked-by: Alan Cox
    Acked-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Jonathan Corbet
     

13 Aug, 2008

1 commit

  • Currently source files in the Documentation/ sub-dir can easily bit-rot
    since they are not generally buildable, either because they are hidden in
    text files or because there are no Makefile rules for them. This needs to
    be fixed so that the source files remain usable and good examples of code
    instead of bad examples.

    Add the ability to build source files that are in the Documentation/ dir.
    Add to Kconfig as "BUILD_DOCSRC" config symbol.

    Use "CONFIG_BUILD_DOCSRC=1 make ..." to build objects from the
    Documentation/ sources. Or enable BUILD_DOCSRC in the *config system.
    However, this symbol depends on HEADERS_CHECK since the header files need
    to be installed (for userspace builds).

    Built (using cross-tools) for x86-64, i386, alpha, ia64, sparc32,
    sparc64, powerpc, sh, m68k, & mips.

    Signed-off-by: Randy Dunlap
    Reviewed-by: Sam Ravnborg
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Randy Dunlap
     

04 Aug, 2008

1 commit


30 Apr, 2008

1 commit


26 Apr, 2008

1 commit


19 Apr, 2008

1 commit

  • * git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-2.6.26: (1090 commits)
    [NET]: Fix and allocate less memory for ->priv'less netdevices
    [IPV6]: Fix dangling references on error in fib6_add().
    [NETLABEL]: Fix NULL deref in netlbl_unlabel_staticlist_gen() if ifindex not found
    [PKT_SCHED]: Fix datalen check in tcf_simp_init().
    [INET]: Uninline the __inet_inherit_port call.
    [INET]: Drop the inet_inherit_port() call.
    SCTP: Initialize partial_bytes_acked to 0, when all of the data is acked.
    [netdrvr] forcedeth: internal simplifications; changelog removal
    phylib: factor out get_phy_id from within get_phy_device
    PHY: add BCM5464 support to broadcom PHY driver
    cxgb3: Fix __must_check warning with dev_dbg.
    tc35815: Statistics cleanup
    natsemi: fix MMIO for PPC 44x platforms
    [TIPC]: Cleanup of TIPC reference table code
    [TIPC]: Optimized initialization of TIPC reference table
    [TIPC]: Remove inlining of reference table locking routines
    e1000: convert uint16_t style integers to u16
    ixgb: convert uint16_t style integers to u16
    sb1000.c: make const arrays static
    sb1000.c: stop inlining largish static functions
    ...

    Linus Torvalds
     

18 Apr, 2008

1 commit


07 Mar, 2008

1 commit

  • Quite a while ago I started this book. The required kernel-doc
    patches have since gone into the tree so it is now possible to
    build the book in mainline.

    The actual documentation is still rather incomplete and not all
    things are linked into the book, but this enables us to edit
    the documentation collaboratively, hopefully driver authors can
    add documentation based on their experience with mac80211.

    Signed-off-by: Johannes Berg
    Signed-off-by: John W. Linville

    Johannes Berg
     

14 Feb, 2008

1 commit

  • Move networking (core and drivers) docbook to its own networking book.
    Fix a few kernel-doc errors in header and source files.

    Signed-off-by: Randy Dunlap
    Cc: Trond Myklebust
    Cc: "J. Bruce Fields"
    Cc: Neil Brown
    Cc: "David S. Miller"
    Signed-off-by: Andrew Morton
    Signed-off-by: Linus Torvalds

    Randy Dunlap
     

12 Jan, 2008

2 commits


29 Nov, 2007

1 commit


20 Oct, 2007

1 commit


12 Oct, 2007

1 commit