1. 24 Jul, 2019 2 commits
  2. 23 Jul, 2018 1 commit
    • Mario Six's avatar
      doc: Replace DocBook with sphinx-based docs · 78a88f79
      Mario Six authored
      The Linux kernel moved to sphinx-based documentation and got rid of the
      DocBook based documentation quite a while ago. Hence, the DocBook
      documentation for U-Boot should be converted as well.
      To achieve this, import the necessary files from Linux v4.17, and
      convert the current DocBook documentation (three files altogether) to
      For now, all old DocBook documentation was merged into a single
      handbook, tentatively named "U-Boot Hacker Manual".
      For some source files, the documentation style was changed to comply
      with kernel-doc; no functional changes were applied.
      Signed-off-by: Mario Six's avatarMario Six <mario.six@gdsys.cc>
  3. 07 Nov, 2014 1 commit
  4. 25 Feb, 2014 1 commit
    • Masahiro Yamada's avatar
      kbuild: consolidate version and timestamp headers generation · 7424145f
      Masahiro Yamada authored
      - Generate include/generated/{timestamp.h, version.h}
         more simply by using filechk rule.
       - Add $(UBOOTRELEASE) variable and re-write u-boot.imx rule
         more simply.
       - Rename U_BOOT_VERSION in Makefile to UBOOTVERSION
         Before this commit, the same variable name, "U_BOOT_VERSION"
         was used for two different strings.
         One of them was defined in Makefile.
         It takes the form like "2014.01-rc1" and used in
         makefiles and script files.
         The other is defined in include/generated/version.h
         It takes the form like "U-Boot 2014.01-rc1-00010-gbe6d4266-dirty"
         and used in C and Aseembler.
         It is confusing when grepping the source tree. So, this commit
         renames the former to UBOOTVERSION.
      Signed-off-by: default avatarMasahiro Yamada <yamada.m@jp.panasonic.com>
  5. 19 Feb, 2014 2 commits
  6. 14 Oct, 2013 1 commit
  7. 15 Oct, 2012 2 commits
    • Marek Vasut's avatar
      kerneldoc: Implement "Example" section handling · 95d45a91
      Marek Vasut authored
      The default kernel-doc strips starting spaces from every single
      line in the Example section. This makes the code look bad. Thus,
      implement special handling for this section.
      Signed-off-by: Marek Vasut's avatarMarek Vasut <marex@denx.de>
    • Marek Vasut's avatar
      kerneldoc: Implant DocBook from Linux kernel · 30ff8918
      Marek Vasut authored
      Pull slightly modified version of Documentation/DocBook, the related perl
      script scripts/kernel-doc and the scripts/docproc.c from Linux kernel and
      implant it into U-Boot. This will allow smooth generation of kerneldoc
      style documentation.
      It was necessary to modify the DocBook/Makefile to work with U-Boot build
      system. The changes were only minor though and involved replacing the kbuild
      specific parts.
      It was also necessary to replace use of variables like KERNEL_VERSION with
      U_BOOT_VERSION, strings like Linux kernel with U-Boot Bootloader etc. so
      the generated result actually matches.
      Finally, it was necessary to adjust docproc.c, since the documentation in
      U-Boot is located in doc/DocBook instead of Documentation/DocBook as is in
      case of the Linux kernel.
      Some parts of the DocBook Makefile are unused, but to allow easier sync with
      Linux kernel, these parts are still left in. The targets enabled now are
      "htmldocs" "pdfdocs" "psdocs" "xmldocs" and "cleandocs" to remove the results
      of documentation build.
      Linux scripts/docproc.c:
      commit f0f3ca8d967462dafb815412b14ca3339b9817a6
      Date:   Wed Jun 15 11:53:13 2011 +0200
      Linux scripts/kernel-doc:
      commit 1b40c1944db445c1de1c47ffd8cd426167f488e8
      Date:   Sun Aug 12 10:46:15 2012 +0200
      Linux Documentation/DocBook:
      commit bb8187d35f820671d6dd76700d77a6b55f95e2c5
      Date:   Thu May 17 19:06:13 2012 -0400
      Signed-off-by: Marek Vasut's avatarMarek Vasut <marex@denx.de>