From 99158cceddacb52ebe30708c4e6a27b4fb711c8f Mon Sep 17 00:00:00 2001 From: Augustin Cavalier Date: Sat, 25 Aug 2018 21:22:54 -0400 Subject: [PATCH] makefile-engine docs: Fix app_name_catalog_entry. Fixes #14392. --- docs/misc/makefile-engine.html | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/misc/makefile-engine.html b/docs/misc/makefile-engine.html index 731c7491cd..5cc06a1a72 100644 --- a/docs/misc/makefile-engine.html +++ b/docs/misc/makefile-engine.html @@ -6,7 +6,7 @@

How To Create a Project Using the Makefile Engine

Haiku helps developers with the build process of their projects by providing the so -called makefile-engine. It's made of two files, that reside in +called makefile-engine. It's made of two files, that reside in /boot/system/develop/etc directory and are named 'Makefile' and 'makefile-engine'.
Together, these two files provide you with a simple ready-to-be used build engine for your projects.

@@ -15,7 +15,7 @@ engine for your projects.

Makefile template v2.6. Regardless of mentioning the 'makefiles' in this How-To, the same technique can be used for creating Jamfile-driven projects. Corresponding Jamfile and Jamfile-engine template files are provided -with Haiku. We made both, the Makefile and Jamfile engines completely +with Haiku. We made both, the Makefile and Jamfile engines completely target-compatible for the user's convenience.

Contents

@@ -32,7 +32,7 @@ target-compatible for the user's convenience.

To start a project, just copy Makefile from /boot/system/develop/etc directory, into your project directory. Write a few files that you want to add to your project. Add -either relative or full paths to them into the SRCS variable definition in the +either relative or full paths to them into the SRCS variable definition in the Makefile and run make. Example files for a "Hello World" project:

hello.cpp:

@@ -80,12 +80,12 @@ needs. Let's take a look at them:

  • STATIC - Static library archive
  • DRIVER - Kernel driver
    • -
  • APP_MIME_SIG specifies the application's mime signature for +
  • APP_MIME_SIG specifies the application's mime signature for localization features. Note that it should correspond to MIME type provided to the BApplication's constructor and the application MIME type defined in resource file. In case this parameter is not set, the default value 'x-vnd.Haiku-$(NAME)' will be used.
    • -
  • SRCS specifies the source files to use. You may specify both, full +
  • SRCS specifies the source files to use. You may specify both, full paths and paths relative to the location of the Makefile. All objects, regardless of the location of their sources will be created in the common object directory. Please note, that this means, that the Makefile @@ -109,7 +109,7 @@ add $(STDCPPLIBS instead of raw "stdc++[.r4] [supc++]" library
  • for localization support add the following libraries: locale localestub
  • if your library doesn't follow the standard library naming scheme, you need to specify the path to the library and its name, e.g. -for the library: my_lib.a, the entry would be either: my_lib.a or +for the library: my_lib.a, the entry would be either: my_lib.a or path/my_lib.a
  • LIBPATHS specifies additional paths to directories following the @@ -193,19 +193,19 @@ actually be able to use localization in your programs, you have to adjust few settings in your Makefile.

      -

    1. Adjust a value to your project's APP_MIME_SIG variable. +

    2. Adjust a value to your project's APP_MIME_SIG variable. Application's mime signature should also be set in the following format: x.vnd-<author>-<project_name>

      3. -

    3. Add following two libraries into your LIBS variable: locale +

    4. Add following two libraries into your LIBS variable: locale localestub

      5. -

    5. Add every language, that you want to support, into LOCALES variable, -e.g. 'LOCALES = en de fr' for English, German and French locale +

    6. Add every language, that you want to support, into LOCALES variable, +e.g. 'LOCALES = en de fr' for English, German and French locale support.

      7. -

    7. Add the resource definition script (also specified in the RDEF +

    8. Add the resource definition script (also specified in the RDEF variable) containing the following entries to project:

      resource app_signature "application/x-vnd.<author>-<project_name>";
-resource appnamecatalog_entry "<author>-<project_name>:System name:Terminal";
      9. +resource app_name_catalog_entry "<author>-<project_name>:System name:Terminal";

    9. Run 'make' to build the binary file.

    10. Run 'make catkeys' to get the locales/en.catkeys file.

    11. Copy this file to locales/<language_code>.catkeys and translate it, @@ -250,13 +250,13 @@ everything in the objects folder.

    12. driverinstall installs the driver in the system.
    13. install installs the program into the directory specified by the INSTALL_DIR variable.
      14. -
    14. catalogsinstall installs localization resource catalogs into +
    15. catalogsinstall installs localization resource catalogs into /boot/home/config/non-packaged/data/locale/catalogs/<APP_MIME_SIG> for testing purposes. Note that for the distribution of a release version, catalogs should be stored in /boot/system/non-packaged/data/locale/catalogs/<APP_MIME_SIG> instead of home. Even better, create a proper HPKG and don't install in any non-packaged folder at all.
      16. -
    16. bindcatalogs binds localization resource catalogs into the executable -file's resources (it's an alternative way of storing localization +
    17. bindcatalogs binds localization resource catalogs into the executable +file's resources (it's an alternative way of storing localization catalogs that doesn't require to distribute separate catalog files).