Pārlūkot izejas kodu

manual: minor typos and formating fixes

Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Samuel Martin 12 gadi atpakaļ
vecāks
revīzija
5664c4af5c

+ 11 - 5
docs/manual/adding-packages-generic.txt

@@ -99,24 +99,30 @@ of the shell script(s) needing fixing. All these names are relative to
 In addition, the scripts listed in +LIBFOO_CONFIG_SCRIPTS+ are removed
 In addition, the scripts listed in +LIBFOO_CONFIG_SCRIPTS+ are removed
 from +$(TARGET_DIR)/usr/bin+, since they are not needed on the target.
 from +$(TARGET_DIR)/usr/bin+, since they are not needed on the target.
 
 
-Example 1:
-
+.Config script: 'divine' package
+================================
 Package divine installs shell script '$(STAGING_DIR)/usr/bin/divine-config'.
 Package divine installs shell script '$(STAGING_DIR)/usr/bin/divine-config'.
 
 
-So it's fixup would be:
+So its fixup would be:
 
 
+--------------------------------
 DIVINE_CONFIG_SCRIPTS = divine-config
 DIVINE_CONFIG_SCRIPTS = divine-config
+--------------------------------
+================================
 
 
-Example 2:
-
+.Config script: 'imagemagick' package:
+================================
 Package imagemagick installs the following scripts:
 Package imagemagick installs the following scripts:
 '$(STAGING_DIR)/usr/bin/{Magick,Magick++,MagickCore,MagickWand,Wand}-config'
 '$(STAGING_DIR)/usr/bin/{Magick,Magick++,MagickCore,MagickWand,Wand}-config'
 
 
 So it's fixup would be:
 So it's fixup would be:
 
 
+--------------------------------
 IMAGEMAGICK_CONFIG_SCRIPTS = \
 IMAGEMAGICK_CONFIG_SCRIPTS = \
    Magick-config Magick++-config \
    Magick-config Magick++-config \
    MagickCore-config MagickWand-config Wand-config
    MagickCore-config MagickWand-config Wand-config
+--------------------------------
+================================
 
 
 On line 14, we specify the list of dependencies this package relies
 On line 14, we specify the list of dependencies this package relies
 on. These dependencies are listed in terms of lower-case package names,
 on. These dependencies are listed in terms of lower-case package names,

+ 4 - 4
docs/manual/contribute.txt

@@ -27,8 +27,8 @@ _rebase_ your development branch on top of the upstream tree before
 generating the patch set. To do so, run:
 generating the patch set. To do so, run:
 
 
 ---------------------
 ---------------------
- $ git fetch --all --tags
- $ git rebase origin/master
+$ git fetch --all --tags
+$ git rebase origin/master
 ---------------------
 ---------------------
 
 
 Here, you are ready to generate then submit your patch set.
 Here, you are ready to generate then submit your patch set.
@@ -36,7 +36,7 @@ Here, you are ready to generate then submit your patch set.
 To generate it, run:
 To generate it, run:
 
 
 ---------------------
 ---------------------
- $ git format-patch -M -n -s -o outgoing origin/master
+$ git format-patch -M -n -s -o outgoing origin/master
 ---------------------
 ---------------------
 
 
 This will generate patch files in the +outgoing+ subdirectory,
 This will generate patch files in the +outgoing+ subdirectory,
@@ -48,7 +48,7 @@ before submitting them using your favorite text editor.
 Lastly, send/submit your patch set to the Buildroot mailing list:
 Lastly, send/submit your patch set to the Buildroot mailing list:
 
 
 ---------------------
 ---------------------
- $ git send-email --to buildroot@busybox.net outgoing/*
+$ git send-email --to buildroot@busybox.net outgoing/*
 ---------------------
 ---------------------
 
 
 Note that +git+ should be configured to use your mail account.
 Note that +git+ should be configured to use your mail account.

+ 5 - 3
docs/manual/make-tips.txt

@@ -29,8 +29,7 @@ The result of the search shows the help message of the matching items.
  $ make help
  $ make help
 --------------------
 --------------------
 
 
-.Not all targets are always available,
-
+Not all targets are always available,
 some settings in the +.config+ file may hide some targets:
 some settings in the +.config+ file may hide some targets:
 
 
 * +linux-menuconfig+ and +linux-savedefconfig+ only work when
 * +linux-menuconfig+ and +linux-savedefconfig+ only work when
@@ -71,12 +70,15 @@ The manual outputs will be generated in 'output/docs/manual'.
   xref:requirement-optional[]).
   xref:requirement-optional[]).
 - There is a known issue that you can't build it under Debian Squeeze.
 - There is a known issue that you can't build it under Debian Squeeze.
 
 
+.Reseting Buildroot for a new target:
+
 To delete all build products as well as the configuration:
 To delete all build products as well as the configuration:
 
 
 --------------------
 --------------------
  $ make distclean
  $ make distclean
 --------------------
 --------------------
 
 
-Note that if +ccache+ is enabled, running +make clean+ or +distclean+ does
+.Notes
+If +ccache+ is enabled, running +make clean+ or +distclean+ does
 not empty the compiler cache used by Buildroot. To delete it, refer
 not empty the compiler cache used by Buildroot. To delete it, refer
 to xref:ccache[].
 to xref:ccache[].