forked from gnustep/tools-make
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gnustep-make.texi
1622 lines (1371 loc) · 68 KB
/
gnustep-make.texi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename gnustep-make.info
@settitle GNUstep Makefile Package
@c %**end of header
@setcontentsaftertitlepage
@smallbook
@setchapternewpage odd
@dircategory Software development
@direntry
* GNUstep Make: (gnustep-make). The GNUstep build system.
@end direntry
@ifinfo
Copyright @copyright{} 2000 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation.
@end ifinfo
@titlepage
@title GNUstep Makefile Package
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 2000 Free Software Foundation, Inc.
@sp 1
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation.
@end titlepage
@page
@c Makefile Package Chapter
@node Top, Makefile Introduction, (dir), (dir)
@chapter Makefile Package
@menu
* Makefile Introduction::
* Makefile Structure::
* Running Make::
* Project Types::
* GNUmakefile.preamble::
* GNUmakefile.postamble::
* Common Variables::
* Other Variables::
@end menu
@node Makefile Introduction, Makefile Structure, Top, Top
@section Introduction
The Makefile package is a system of make commands that is designed to
encapsulate all the complex details of building and installing various types
of projects from libraries to applications to documentation. This frees the
developer to focus on the details of their particular project. Only
a fairly simple main makefile need to be written which specifies the
type of project and files involved in the project.
@node Makefile Structure, Running Make, Makefile Introduction, Top
@section Structure of a Makefile
Here is an example makefile (named GNUmakefile to emphasis the fact that it relies on special features of the GNU make program).
@smallexample
#
# An example GNUmakefile
#
# Include the common variables defined by the Makefile Package
include $(GNUSTEP_MAKEFILES)/common.make
# Build a simple Objective-C program
TOOL_NAME = simple
# The Objective-C files to compile
simple_OBJC_FILES = simple.m
-include GNUmakefile.preamble
# Include in the rules for making GNUstep command-line programs
include $(GNUSTEP_MAKEFILES)/tool.make
-include GNUmakefile.postamble
@end smallexample
This is all that is necessary to define the project.
@node Running Make, Project Types, Makefile Structure, Top
@section Running Make
@menu
* Debug Information::
* Profile Information::
* Library Types::
@end menu
Normally to compile a package which uses the Makefile Package it is
purely a matter of typing @code{make} from the top-level directory of
the package, and the package is compiled without any additional
interaction.
@node Debug Information, Profile Information, Running Make, Running Make
@subsection Debug Information
By default the Makefile Package tells the compiler to generate
debugging information when compiling Objective-C and C files. The
following command illustrates how to tell the Makefile Package to pass
the appropriate flags to the compiler so that debugging information is
not put into the binary files.
@smallexample
make debug=no
@end smallexample
@node Profile Information, Library Types, Debug Information, Running Make
@subsection Profile Information
By default the Makefile Package does not tell the compiler to generate
profiling information when compiling Objective-C and C files. The
following command illustrates how to tell the Makefile Package to pass
the appropriate flags to the compiler so that profiling information is
put into the binary files.
@smallexample
make profile=yes
@end smallexample
@node Library Types, , Profile Information, Running Make
@subsection Static, Shared, and Dynamic Link Libraries
By default the Makefile Package will generate a shared library if it is
building a library project type, and it will link with shared libraries
if it is building an application or command line tool project type. The
following command illustrates how to tell the Makefile Package not to
build using shared libraries but using static libraries instead.
@smallexample
make shared=no
@end smallexample
This default is only applicable on systems that support shared
libraries; systems that do not support shared libraries will always
build using static libraries. Some systems support dynamic link
libraries (DLL) which are a form of shared libraries; on these systems,
DLLs will be built by default unless the Makefile Package is told to
build using static libraries instead, as in the above command.
@node Project Types, GNUmakefile.preamble, Running Make, Top
@section Project Types
@menu
* aggregate.make::
* application.make::
* bundle.make::
* ctool.make::
* documentation.make::
* framework.make::
* java.make::
* library.make::
* native-library.make::
* nsis.make::
* objc.make::
* palette.make::
* rpm.make::
* service.make::
* subproject.make::
* tool.make::
@end menu
Projects are divided into different types described below. To create a
project of a specific type, just include the particular makefile. For
example, to create an application, include this line in your main make
file:
@example
include $(GNUSTEP_MAKEFILES)/application.make
@end example
Each project type is independent of the others. If you want to create
two different types of projects within the same directory (e.g. a tool
and a java program), include both the desired makefiles in your main
make file.
The documentation for variables used to control each project type is
provided at the start of each individual makefile (common.make and rules.make
document more general variables).
The documentation for installing resources (a feature shared by many project
types) is in resource-set.make.
@node aggregate.make, application.make, Project Types, Project Types
@subsection Aggregate (@file{aggregate.make})
An Aggregate project is a project that consists of several
subprojects. Each subproject can be of any other valid project type
(including the Aggregate type). The only project variable is the
SUBPROJECTS variable
@defvr {Aggregate project} SUBPROJECTS
@code{SUBPROJECTS} defines the directory names that hold the subprojects
that the Aggregate project should build.
@end defvr
@node application.make, bundle.make, aggregate.make, Project Types
@subsection Graphical Applications (@file{application.make})
An application is an Objective-C program that includes a GUI component,
and by default links in all the GNUstep libraries required for GUI
development, such as the Base and Gui libraries.
@node bundle.make, ctool.make, application.make, Project Types
@subsection Bundles (@file{bundle.make})
A bundle is a collection of resources and code that can be used to
enhance an existing application or tool dynamically using the NSBundle
class from the GNUstep base library.
@node ctool.make, documentation.make, bundle.make, Project Types
@subsection Command Line C Tools (@file{ctool.make})
A ctool is a project that only uses C language files.
Otherwise it is similar to the ObjC project type.
@node documentation.make, framework.make, ctool.make, Project Types
@subsection Documentation (@file{documentation.make})
The Documentation project provides rules to use various types of
documentation such as texi and LaTeX documentation, and convert them
into finished documentation (info, PostScript, HTML, etc).
@node framework.make, java.make, documentation.make, Project Types
@subsection Frameworks (@file{framework.make})
A Framework is a collection of resources and a library that provides
common code that can be linked into a Tool or Application. In many
respects it is similar to a Bundle.
@node java.make, library.make, framework.make, Project Types
@subsection Java (@file{java.make})
This project provides rules for building java programs. It also makes it
easy to make java projects that interact with the GNUstep libraries.
@subsubsection Project Variables
@defvr {Java project} JAVA_PACKAGE_NAME
@code{JAVA_PACKAGE_NAME} is the reverse DNS style Java package name that
resides in this project.
@end defvr
@defvr {Java project} JAVA_FILES
@code{xxx_JAVA_FILES} is the list of Java source code files, with a
@file{.java} extension, that are compiled for the @strong{xxx} project.
@strong{xxx} should be replaced with the name of the Java package
specified in @code{JAVA_PACKAGE_NAME}.
@end defvr
@defvr {Java project} JAVA_JNI_FILES
@code{xxx_JAVA_JNI_FILES} is the list of Java source code files for
which @code{javah} should produce header files for integration with
Objective-C code.
@strong{xxx} should be replaced with the name of the Java package
specified in @code{JAVA_PACKAGE_NAME}.
@end defvr
@defvr {Java project} JAVA_PROPERTIES_FILES
@code{xxx_JAVA_PROPERTIES_FILES} can be used to specify properties files
to install.
@strong{xxx} should be replaced with the name of the Java package
specified in @code{JAVA_PACKAGE_NAME}.
@end defvr
@defvr {Java project} JAVA_MANIFEST_FILE
@code{xxx_JAVA_MANIFEST_FILE} can be used to specify a manifest fragment
that is used when building a jar file for the @strong{xxx} package.
@strong{xxx} should be replaced with the name of the Java package
specified in @code{JAVA_PACKAGE_NAME}.
@end defvr
@defvr {Java project} JAVA_JAR_NAME
@code{xxx_JAVA_JAR_NAME} can be used to specify a custom name for the jar
built by @code{make jar}. The default would be the package name (@strong{xxx})
with all dots replaced by hyphens.
@end defvr
@node library.make, native-library.make, java.make, Project Types
@subsection Libraries (@file{library.make})
@menu
* library.make variables::
* Example Library Makefile::
@end menu
The Makefile Package provides a project type for building libraries;
libraries can be built as static libraries, shared libraries, or dynamic
link libraries (DLL) if the platform supports that type of library.
Static libraries are supported on all platforms; while, shared libraries
and DLLs are only supported on some platforms.
@node library.make variables, Example Library Makefile, library.make, library.make
@subsubsection Project Variables
@defvr {Library project} LIBRARY_NAME
@code{LIBRARY_NAME} should be assigned the list of name of libraries to
be generated. Most UNIX systems expect that the filename for the
library has the word @file{lib} prefixed to the name; i.e. the @file{c}
library has filename of @file{libc}. Prefix the @file{lib} to the
library name when it is specified in the @code{LIBRARY_NAME} variable
because the Makefile Package will not automatically prefix it.
@end defvr
@defvr {Library project} C_FILES
@code{xxx_C_FILES} is the list of C files, with a @file{.c} extension,
that are to be compiled to generate the @strong{xxx} library.
Replace the @strong{xxx} with the name of the library as listed by
the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} OBJC_FILES
@code{xxx_OBJC_FILES} is the list of Objective-C files, with a @file{.m}
extension, that are to be compiled to generate the @strong{xxx} library.
Replace the @strong{xxx} with the name of the library as listed by the
@code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} PSWRAP_FILES
@code{xxx_PSWRAP_FILES} is the list of PostScript wrap files, with a
@file{.psw} extension, that are to be compiled to generate the
@strong{xxx} library. PostScript wrap files are processed by the
@file{pswrap} utility which generates a @file{.c} and a @file{.h} file
from each @file{.psw} file; the generate @file{.c} file is the file
actually compiled. Replace the @strong{xxx} with the name of the
library as listed by the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} HEADER_FILES
@code{xxx_HEADER_FILES} is the list of header filenames that are to be
installed with the library. If a filename has a directory path prefixed
to it then that prefix will be maintained when the headers are
installed. It is up to the user to make sure that the installation
directory exists; otherwise, an error will occur when the library is
installed, see @ref{library.make
variables,,xxx_HEADER_FILES_INSTALL_DIR}. Replace the @strong{xxx} with
the name of the library as listed by the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} HEADER_FILES_DIR
@code{xxx_HEADER_FILES_DIR} is the relative path from the current
directory, where the makefile is located, to where the header files
specified by @code{xxx_HEADER_FILES} are located. If a filename
specified in @code{xxx_HEADER_FILES} has a directory path prefixed to it
then that path will not be removed when the Makefile Package accesses
the files, so do not specify a path with @code{xxx_HEADER_FILES_DIR}
that is already prefixed to the header filenames, see @ref{library.make
variables,,xxx_HEADER_FILES_INSTALL_DIR}. @code{xxx_HEADER_FILES_DIR}
is optional; leaving it blank or undefined, and the Makefile Package
assumes that the relative path to the header files is the current
directory where the makefile resides. Replace the @strong{xxx} with the
name of the library as listed by the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} HEADER_FILES_INSTALL_DIR
@code{xxx_HEADER_FILES_INSTALL_DIR} specifies the relative subdirectory
path below @code{GNUSTEP_HEADERS} where the header files are to be
installed. If this directory or any of its parent directories do not
exist, then the Makefile Package will create them. The Makefile Package
prefixes @code{xxx_HEADER_FILES_INSTALL_DIR} to each of the filenames in
@code{xxx_HEADER_FILES} when they are installed, so if the filenames in
@code{xxx_HEADER_FILES} already have a directory path prefixed then the
user is responsible for creating that directory, the Makefile Package
will not create. @code{xxx_HEADER_FILES_INSTALL_DIR} is optional;
leaving it blank or undefined, and the Makefile Package assumes that the
installation directory is just @code{GNUSTEP_HEADERS} with no
subdirectory. Replace the @strong{xxx} with the name of the library as
listed by the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} CPPFLAGS
@code{xxx_CPPFLAGS} are additional flags that will be passed to the
compiler preprocessor when compiling Objective-C and C files to generate
the @strong{xxx} library. Adding flags here does not override the
default @code{CPPFLAGS}, see @ref{Overridable Flags,,CPPFLAGS}, they are
in addition to @code{CPPFLAGS}. These flags are specific to the
@strong{xxx} library, see @ref{GNUmakefile.preamble,,ADDITIONAL_CPPFLAGS},
to see how to specify global preprocessor flags. Replace the
@strong{xxx} with the name of the listed as listed by the
@code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} OBJCFLAGS
@code{xxx_OBJCFLAGS} are additional flags that will be passed to the
compiler when compiling Objective-C files to generate the @strong{xxx}
library. Adding flags here does not override the default
@code{OBJCFLAGS}, see @ref{Overridable Flags,,OBJCFLAGS}, they are in
addition to @code{OBJCFLAGS}. These flags are specific to the
@strong{xxx} library, see @ref{GNUmakefile.preamble,,ADDITIONAL_OBJCFLAGS},
to see how to specify global compiler flags. Replace the @strong{xxx}
with the name of the library as listed by the @code{LIBRARY_NAME}
variable.
@end defvr
@defvr {Library project} CFLAGS
@code{xxx_CFLAGS} are additional flags that will be passed to the
compiler when compiling C files to generate the @strong{xxx} library.
Adding flags here does not override the default @code{CFLAGS}, see
@ref{Overridable Flags,,CFLAGS}, they are in addition to @code{CFLAGS}.
These flags are specific to the @strong{xxx} library, see
@ref{GNUmakefile.preamble,,ADDITIONAL_CFLAGS}, to see how to specify global
compiler flags. Replace the @strong{xxx} with the name of the library
as listed by the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} LDFLAGS
@code{xxx_LDFLAGS} are additional flags that will be passed to the
linker when it creates the @strong{xxx} library. Adding flags here does
not override the default @code{LDFLAGS}, see @ref{Overridable
Flags,,LDFLAGS}, they are in addition to @code{LDFLAGS}. These flags
are specific to the @strong{xxx} library, see
@ref{GNUmakefile.preamble,,ADDITIONAL_LDFLAGS}, to see how to specify
global linker flags. Replace the @strong{xxx} with the name of the
library as listed by the @code{LIBRARY_NAME} variable.
@end defvr
@defvr {Library project} INCLUDE_DIRS
@code{xxx_INCLUDE_DIRS} is the list of additional directories that the
compiler will search when it is looking for include files; these flags
are specific to the @strong{xxx} library, see
@ref{GNUmakefile.preamble,,ADDITIONAL_INCLUDE_DIRS}, to see how to specify
additional global include directories. The directories should be
specified as @samp{-I} flags to the compiler. The additional include
directories will be placed before the normal GNUstep and system include
directories, and before any global include directories specified with
@code{ADDITIONAL_INCLUDE_DIRS}, so they will always be searched first.
Replace the @strong{xxx} with the name of the library as listed by the
@code{LIBRARY_NAME} variable.
@end defvr
@node Example Library Makefile, , library.make variables, library.make
@subsubsection Example Makefile
This example makefile illustrates two libraries, @file{libone} and
@file{libtwo}, that are to be generated.
@smallexample
#
# An example GNUmakefile
#
# Include the common variables defined by the Makefile Package
include $(GNUSTEP_MAKEFILES)/common.make
# Two libraries
LIBRARY_NAME = libone libtwo
#
# The files for the libone library
#
# The Objective-C files to compile
libone_OBJC_FILES = one.m draw.m
# The C source files to be compiled
libone_C_FILES = parse.c
# The PostScript wrap source files to be compiled
libone_PSWRAP_FILES = drawing.psw
# The header files for the library
libone_HEADER_FILES_DIR = ./one
libone_HEADER_FILES_INSTALL_DIR = one
libone_HEADER_FILES = one.h draw.h
#
# The files for the libtwo library
#
# The Objective-C files to compile
libtwo_OBJC_FILES = two.m another.m test.m
# The header files for the library
libtwo_HEADER_FILES_DIR = ./two
libtwo_HEADER_FILES_INSTALL_DIR = two
libtwo_HEADER_FILES = two.h another.h test.h common.h
# Option include to set any additional variables
-include GNUmakefile.preamble
# Include in the rules for making libraries
include $(GNUSTEP_MAKEFILES)/library.make
# Option include to define any additional rules
-include GNUmakefile.postamble
@end smallexample
Notice that the @file{libone} library has Objective-C, C, and PostScript
wrap files to be compiled; while, the @file{libtwo} library only has
some Objective-C files.
The header files for the @file{libone} library reside in the @file{one}
subdirectory from where the sources are located, and the header files
will be installed into the @file{one} subdirectory within
@code{GNUSTEP_HEADERS}. Likewise the header files for the @file{libtwo}
library reside in the @file{two} subdirectory from where the sources are
located, and the header files will be installed into the @file{two}
subdirectory within @code{GNUSTEP_HEADERS}.
@node native-library.make, nsis.make, library.make, Project Types
@subsection Native Library (@file{native-library.make})
A "native library" is a project which is to be built as a shared
library on most targets and as a framework on Darwin. (Currently
this is only the case for apple-apple-apple.) In other
words, it is to be built as the most appropriate native equivalent
of a traditional shared library (see @ref{library.make} and
@ref{framework.make}).
@defvr {Native Library project} NATIVE_LIBRARY_NAME
@code{NATIVE_LIBRARY_NAME} should be the name of the native library,
without the 'lib'. All the other variables are the same as
the ones used in libraries and frameworks.
@end defvr
To compile something against a native library, you can use
@code{ADDITIONAL_NATIVE_LIBS += MyLibrary}
This will be converted into -lMyLibrary link flag on for most
targets and into -framework MyLibrary link flag for
apple-apple-apple.
To add the corresponding flags, you can use
@code{ADDITIONAL_NATIVE_LIB_DIRS += ../MyPath}
This will be converted into -L../MyPath/$(GNUSTEP_OBJ_DIR) flag
on for most targets and into -F../MyPath flag for apple-apple-apple.
@node nsis.make, objc.make, native-library.make, Project Types
@subsection NSIS Installer (@file{nsis.make})
The NSIS make project provides rules for automatically generating NSIS
installers for Windows operating systems. In order to get this functionality,
include @file{Master/nsis.make} from the Makefiles directory in your
GNUmakefile.
@example
include $(GNUSTEP_MAKEFILES)/Master/nsis.make
@end example
To create an installer file by itself, run @code{make nsifile}. To
create the full installer executable, run @code{make nsis}. Note that in
order to do this, you must be either running on a Windows computer with
a release of the NSIS compiler (from @url{http://nsis.sourceforge.net}) or you
need to be using a cross-compiler and cross-compiled NSIS script compiler.
(NOTE: This does not currently work - you need to use the GUI NSIS compiler
to compile the installer scripts).
Currently the nsis make package only makes installers for
Applications. It will use the @file{nsi-app.template} file in the
GNUstep Makefiles directory. If you want, you can provide your own
template with customized script instructions by creating a file called
@file{PACKAGE_NAME.nsi.in}, where @code{PACKAGE_NAME} is the same as the
name of your package (see below).
You also need to define several variables in your main make file.
Except for @code{PACKAGE_NAME}, which is required, all the following
variables are optional.
@defvr {NSIS} PACKAGE_NAME
@code{PACKAGE_NAME} defines the name of the NSIS installer. In most
cases this will be the same as the name of your project type. For
instance, if you are creating a application, and have set
@code{APP_NAME} to @samp{MyApplication}, Then set @code{PACKAGE_NAME} to
the same thing, or just use @code{PACKAGE_NAME=$(APP_NAME)}. if
@code{PACKAGE_NAME} is not set, it defaults to @code{unnamed-package}
@end defvr
@defvr {NSIS} PACKAGE_VERSION
Set @code{PACKAGE_VERSION} to the release version number of your package. If not
set, it defaults to 0.0.1
@end defvr
@defvr {NSIS} GNUSTEP_INSTALLATION_DOMAIN
Set @code{GNUSTEP_INSTALLATION_DOMAIN} to the domain where you want to install
the software. This should be either @code{SYSTEM}), @code{LOCAL}, or @code{USER}.
If not set it defaults to @code{LOCAL}.
@end defvr
@node objc.make, palette.make, nsis.make, Project Types
@subsection Objective-C Programs (@file{objc.make})
@menu
* objc.make variables::
* Example ObjC Makefile::
@end menu
The Makefile Package provides a project type that is useful for building
Objective-C programs that do not depend upon the GNUstep libraries.
Objective-C programs which only use the Objective-C Runtime Library and
the classes it defines are candidates for this project type.
@node objc.make variables, Example ObjC Makefile, objc.make, objc.make
@subsubsection Project Variables
Most of the project variables work the same as in Library
projects (see @ref{library.make}).
@defvr {Objective-C program project} OBJC_PROGRAM_NAME
@code{OBJC_PROGRAM_NAME} is the list of names of Objective-C programs
that are to be built; each name should be unique as it is the name of
the executable file that will be generated.
@end defvr
@defvr {Objective-C program project} OBJC_LIBS
@code{xxx_OBJC_LIBS} is the list of additional libraries that the linker
will use when linking to create the @strong{xxx} Objective-C program
executable file. These libraries are specific to the @strong{xxx}
Objective-C program, see @ref{GNUmakefile.preamble,,ADDITIONAL_OBJC_LIBS},
to see how to specify additional global libraries. These libraries are
placed before all of the Objective-C Runtime and system libraries, and
before the global libraries specified with @code{ADDITIONAL_OBJC_LIBS},
so that they will be searched first when linking. The additional
libraries should be specified as @samp{-l} flags to the linker as the
following example illustrates. Replace the @strong{xxx} with the name
of the program as listed by the @code{OBJC_PROGRAM_NAME} variable.
@end defvr
@node Example ObjC Makefile, , objc.make variables, objc.make
@subsubsection Example Makefile
This makefile illustrates two Objective-C programs, @file{simple} and
@file{list} that are to be generated.
@smallexample
#
# An example GNUmakefile
#
# Include the common variables defined by the Makefile Package
include $(GNUSTEP_MAKEFILES)/common.make
# Build a simple Objective-C program
OBJC_PROGRAM_NAME = simple list
# Have the Objective-C runtime macro be defined for simple program
simple_CPPFLAGS = $(RUNTIME_DEFINE)
# The Objective-C files to compile for simple program
simple_OBJC_FILES = simple.m
# The Objective-C files to compile for list program
list_OBJC_FILES = list.m linkedlist.m
# The C files to compile for list program
list_C_FILES = sort.c
# Option include to set any additional variables
-include GNUmakefile.preamble
# Include in the rules for making Objective-C programs
include $(GNUSTEP_MAKEFILES)/objc.make
# Option include to define any additional rules
-include GNUmakefile.postamble
@end smallexample
The @file{simple} Objective-C program only consists of single
Objective-C file; while, the @file{list} Objective-C program consists of
two Objective-C files and one C file. The @file{simple} Objective-C
program use the variable defined by the Makefile Package,
@code{RUNTIME_DEFINE}, to define a macro based upon the Objective-C
Runtime library; presumably @file{simple.m} has code which is dependent
upon the Objective-C Runtime.
@node palette.make, rpm.make, objc.make, Project Types
@subsection Palettes (@file{palette.make})
A palette is a Bundle that provides some kind of GUI functionality.
Otherwise it is similar to the Bundle project.
@node rpm.make, service.make, palette.make, Project Types
@subsection RPMs (@file{rpm.make})
The RPM project provides rules for automatically generating RPM spec
files in order to make RPM distributions. Note that this project
makefile is included automatically when you include any other project
type in your GNUmakefile. It is non necessary to include
@file{rpm.make}.
Except for @code{PACKAGE_NAME}, which is required, all the following
variables are optional. It is recommended that you set them anyway in
order to provide the standard information that is present in most RPM
distributions.
@defvr {RPM} PACKAGE_NAME
@code{PACKAGE_NAME} defines the name of the RPM distribution. In most
cases this will be the same as the name of your project type. For
instance, if you are creating a application, and have set
@code{APP_NAME} to @samp{MyApplication}, Then set @code{PACKAGE_NAME} to
the same thing, or just use @code{PACKAGE_NAME=$(APP_NAME)}. if
@code{PACKAGE_NAME} is not set, it defaults to @code{unnamed-package}
@end defvr
@defvr {RPM} PACKAGE_VERSION
Set @code{PACKAGE_VERSION} to the release version number of your package. If not
set, it defaults to 0.0.1
@end defvr
@defvr {RPM} GNUSTEP_INSTALLATION_DOMAIN
Set @code{GNUSTEP_INSTALLATION_DOMAIN} to the domain where you want to install
the software. This should be either @code{SYSTEM}), @code{LOCAL}, or @code{USER}.
If not set it defaults to @code{LOCAL}.
@end defvr
@defvr {RPM} PACKAGE_NEEDS_CONFIGURE
Set this to @code{YES} if a configure script needs to be run before
compilation
@end defvr
In addition you need to provide a stub spec file named for the package
name, such as this example @file{libobjc.spec.in} file:
@example
Release: 1
Source: ftp://ftp.gnustep.org/pub/gnustep/libs/%@{gs_name@}-%@{gs_version@}.
tar.gz
Copyright: GPL
Group: Development/Libraries
Summary: Objective-C Runtime Library
Packager: Adam Fedor <fedor@@gnu.org>
Vendor: The GNUstep Project
URL: http://www.gnustep.org/
%description
Library containing the Objective-C runtime.
@end example
@node service.make, subproject.make, rpm.make, Project Types
@subsection Services (@file{service.make})
A Service is like a Tool that provides a service to a running GNUstep program.
@node subproject.make, tool.make, service.make, Project Types
@subsection Subprojects (@file{subproject.make})
A Subproject provides a way to organize code in a large application into
subunits. The code in the subproject is merged in with the main tool
or application.
@node tool.make, , subproject.make, Project Types
@subsection Command Line Tools (@file{tool.make})
A tool is an ObjC project that by default links in the GNUstep base
library. Otherwise it is similar to the ObjC project type.
@node GNUmakefile.preamble, GNUmakefile.postamble, Project Types, Top
@section Global Variables (@file{GNUmakefile.preamble})
@file{GNUmakefile.preamble} is an optional file that may be put within the
package for declaring global makefile variables for the package. The
filename, @file{GNUmakefile.preamble}, is just a convention; likewise, the
variables defined within it can be put in the normal @file{GNUmakefile}
versus in this special file. However, the reason for this convention is
that the @file{GNUmakefile} may be automatically maintained by a project
management system, like Project Center, so any changes made to
@file{GNUmakefile} may be discarded by that project management system.
The file, @file{GNUmakefile.preamble}, in the Makefile Package is a
template that can be used the project's @file{GNUmakefile.preamble}. It is
not necessary to have a @file{GNUmakefile.preamble} with the project unless
it is actually needed, the Makefile Package will only include it if it
is available, see @ref{Makefile Structure} for information on how the
Makefile Package includes a @file{GNUmakefile.preamble}.
The rest of this section describes the individual global variables that
the Makefile Package uses which are generally placed in the package's
@file{GNUmakefile.preamble}.
@defvar ADDITIONAL_CPPFLAGS
@code{ADDITIONAL_CPPFLAGS} are additional flags that will be passed to
the compiler preprocessor. Generally any macros to be defined for all
files are placed here; the are passed for both Objective-C and C files
that are compiled. @code{RUNTIME_DEFINE}, @code{FOUNDATION_DEFINE},
@code{GUI_DEFINE}, and @code{GUI_BACKEND_DEFINE} are some makefile
variables which define macros that can be assigned to
@code{ADDITIONAL_CPPFLAGS}. The following example illustrates the use
of @code{ADDITIONAL_CPPFLAGS} to define a macro for the Objective-C
Runtime Library plus an additional macro that is specific to the
package.
@end defvar
@smallexample
ADDITIONAL_CPPFLAGS = $(RUNTIME_DEFINE) -DVERBOSE=1
@end smallexample
@defvar ADDITIONAL_OBJCFLAGS
@code{ADDITIONAL_OBJCFLAGS} are additional flags that will be passed to
the compiler when compiling Objective-C files. Adding flags here does
not override the default @code{OBJCFLAGS}, see @ref{Overridable
Flags,,OBJCFLAGS}, they are in addition to @code{OBJCFLAGS}. Generally
@code{ADDITIONAL_OBJCFLAGS} are placed before @code{OBJCFLAGS} when the
compiler is executed, but one should avoid having any placement
sensitive flags because the order of the flags is not guaranteed. The
following example illustrates how you can pass additional Objective-C
flags.
@end defvar
@smallexample
ADDITIONAL_OBJCFLAGS = -Wno-protocol
@end smallexample
@defvar ADDITIONAL_CFLAGS
@code{ADDITIONAL_CFLAGS} are additional flags that will be passed to the
compiler when compiling C files. Adding flags here does not override
the default @code{CFLAGS}, see @ref{Overridable Flags,,CFLAGS}, they are
in addition to @code{CFLAGS}. Generally @code{ADDITIONAL_CFLAGS} are
placed before @code{CFLAGS} when the compiler is executed, but one
should avoid having any placement sensitive flags because the order of
the flags is not guaranteed. The following example illustrates how you
can pass additional C flags.
@end defvar
@smallexample
ADDITIONAL_CFLAGS = -finline-functions
@end smallexample
@defvar ADDITIONAL_LDFLAGS
@code{ADDITIONAL_LDFLAGS} are additional flags that will be passed to
the linker when it creates an executable; these flags are passed when
linking a command line tool, and application, or an Objective-C program.
Adding flags here does not override the default @code{LDFLAGS}, see
@ref{Overridable Flags,,LDFLAGS}, they are in addition to
@code{LDFLAGS}. Generally @code{ADDITIONAL_LDFLAGS} are placed before
@code{LDFLAGS} when the linker is executed, but one should avoid having
any placement sensitive flags because the order of the flags is not
guaranteed. The following example illustrates how you can pass addition
linker flags.
@end defvar
@smallexample
ADDITIONAL_LDFLAGS = -v
@end smallexample
@defvar ADDITIONAL_INCLUDE_DIRS
@code{ADDITIONAL_INCLUDE_DIRS} is the list of additional directories that
the compiler will search when it is looking for include files. The
directories should be specified as @samp{-I} flags to the compiler. The
additional include directories will be placed before the normal GNUstep
and system include directories, so they will always be searched first.
The following example illustrates two additional include directories;
@code{/usr/local/gnu/include} will be searched first, then
@code{/usr/gnu/include}, and finally the GNUstep and system directories
which are automatically defined by the Makefile Package.
@end defvar
@smallexample
ADDITIONAL_INCLUDE_DIRS = -I/usr/local/gnu/include -I/usr/gnu/include
@end smallexample
@defvar ADDITIONAL_LIB_DIRS
@code{ADDITIONAL_LIB_DIRS} is the list of additional directories that
the linker will search when it is looking for library files. The
directories should be specified as @samp{-L} flags to the linker. The
additional library directories will be placed before the GNUstep and
system library directories so that they will be searched first by the
linker. The following example illustrates two additional library
directories; @code{/usr/local/gnu/lib} will be searched first, then
@code{/usr/gnu/lib}, and finally the GNUstep and system directories
which are automatically defined by the Makefile Package.
@end defvar
@smallexample
ADDITIONAL_LIB_DIRS = -L/usr/local/gnu/lib -L/usr/gnu/lib
@end smallexample
@defvar ADDITIONAL_OBJC_LIBS
@code{ADDITIONAL_OBJC_LIBS} is the list of additional libraries that the
linker will use when linking command line tools, applications, and
Objective-C programs, see @ref{tool.make}, @ref{application.make}, and
@ref{objc.make}. For Objective-C programs, @code{ADDITIONAL_OBJC_LIBS}
is placed before all of the Objective-C Runtime and system libraries so
that they will be searched first when linking. For command line tools
and applications, @code{ADDITIONAL_OBJC_LIBS} is placed @emph{before}
all of the Objective-C Runtime and system libraries but @emph{after} the
Foundation and GUI libraries. Libraries specified with
@code{ADDITIONAL_OBJC_LIBS} should only depend upon the Objective-C
Runtime and/or system functions, not Foundation or GUI classes;
Foundation dependent libraries should be specified with
@code{ADDITIONAL_TOOL_LIBS} and GUI dependent libraries should be
specified with @code{ADDITONAL_GUI_LIBS}. The additional libraries
should be specified as @samp{-l} flags to the linker as the following
example illustrates.
@end defvar
@smallexample
ADDITIONAL_OBJC_LIBS = -lSwarm
@end smallexample
@defvar ADDITIONAL_TOOL_LIBS
@code{ADDITIONAL_TOOL_LIBS} is the list of additional libraries that the
linker will use when linking command line tools and applications, see
@ref{tool.make} and @ref{application.make}. For command line tools,
@code{ADDITIONAL_TOOL_LIBS} is placed before all of the GNUstep and
system libraries so that they will be searched first when linking. For
applications, @code{ADDITIONAL_TOOL_LIBS} is placed before the
Foundation and system libraries but after the GUI libraries. Libraries
specified with @code{ADDITIONAL_TOOL_LIBS} should only depend upon the
Foundation classes and/or system functions, not GUI classes; GUI
dependent libraries should be specified with @code{ADDITIONAL_GUI_LIBS}.
The additional libraries should be specified as @samp{-l} flags to the
linker as the following example illustrates.
@end defvar
@smallexample
ADDITIONAL_TOOL_LIBS = -lone -lsimple
@end smallexample
@defvar ADDITIONAL_GUI_LIBS
@code{ADDITIONAL_GUI_LIBS} is the list of additional libraries that the
linker will use when linking applications, see @ref{application.make}.
@code{ADDITIONAL_GUI_LIBS} is placed before all of the GUI, Foundation,
and system libraries so that they will be searched first when linking.
The additional libraries should be specified as @samp{-l} flags to the
linker as the following example illustrates.
@end defvar
@smallexample
ADDITIONAL_GUI_LIBS = -lMiscGui
@end smallexample
@defvar GS_WITH_ARC
@code{GS_WITH_ARC} may be set to 1 to say that Objective-C source code
is to be compiled for ARC memory management. This variable must be set
before @file{common.make} is included, and only works if the library
combo includes the 'ng' runtime specification.
@end defvar
@defvar LIBRARIES_DEPEND_UPON
@code{LIBRARIES_DEPEND_UPON} is the set of libraries that the shared
library depends upon, see @ref{library.make} for more information about
building shared libraries; this variable is only relevant for library
project types. On some platforms when a shared library is built, any
libraries which the object code in the shared library depends upon must
be linked in the generation of the shared library. This is similar to
the process of linking an executable file like a command line tool or
Objective-C program except that the result is a shared library.
Libraries specified with @code{LIBRARIES_DEPEND_UPON} should be listed
as @samp{-l} flags to the linker; when possible use variables defined by
the Makefile Package to specify GUI, Foundation, or system libraries;
like @code{GUI_LIBS}, @code{FND_LIBS}, @code{OBJC_LIBS}, or
@code{SYSTEM_LIBS}. @code{LIBRARIES_DEPEND_UPON} is independent of
@code{ADDITIONAL_OBJC_LIBS}, @code{ADDITIONAL_TOOL_LIBS}, and
@code{ADDITIONAL_GUI_LIBS}, so any libraries specified there may need to
be specified with @code{LIBRARIES_DEPEND_UPON}. The following example
illustrates the use of @code{LIBRARIES_DEPEND_UPON} for a shared library
that is depend upon the Foundation, ObjC, system libraries and an
additional user library.
@end defvar
@smallexample
LIBRARIES_DEPEND_UPON = -lsimple $(FND_LIBS) $(OBJC_LIBS) $(SYSTEM_LIBS)
@end smallexample
@defvar ADDITIONAL_INSTALL_DIRS
@code{ADDITIONAL_INSTALL_DIRS} is the list of additional directories
that should be created when the Makefile Package installs the file for
the project. These directories are only one that the project needs to
be created but that the Makefile Package does not automatically
create. The directories should be absolute paths but use the
@code{GNUSTEP_LIBRARY} variable and other Makefile Package define
variables, see @ref{Directory Paths}, so that the directories get
created in the appropriate place relative to the other file installed
for the project. The following example illustrates how two additional
directories can be created during installation.
@end defvar
@smallexample
ADDITIONAL_INSTALL_DIRS = $(GNUSTEP_RESOURCES)/MyProject
@end smallexample
@node GNUmakefile.postamble, Common Variables, GNUmakefile.preamble, Top
@section Global Rules (@file{GNUmakefile.postamble})
The @file{GNUmakefile.postamble} file is an optional file you may
include in your package to define additional rules that should be
executed when making and/or installing the project. There is a template
@file{GNUmakefile.postamble} file in the Makefile package that you can
use as an example. Most of the rules are self explanatory. The
@samp{before-} rules define things that should happen before a process
is executed (e.g. @samp{before-all} for before compilation,
@samp{before-install} for before installation). The @samp{after-} rules
define things that should happen after a process is complete.
You can even define additional rules such as ones that a particular to
your specific package or that are to be used by developers only.
@node Common Variables, Other Variables, GNUmakefile.postamble, Top
@section Common Variables (@file{common.make})