anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-09-19 14:30:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

INSTALL.cmake: typos, grammar, and whitespace

Browse Source
This commit is contained in:
Scott Kostyshak 2013-01-30 01:45:42 -05:00
parent 14d388e0db
commit b8eb4bb99b
1 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
INSTALL.cmake
View File

@ -15,15 +15,15 @@ Building LyX with CMake
installing Qt fix PATH,
Linux/Unix: export PATH=<your path to qt>/bin:$PATH
Windows : set PATH=<your path to qt>\bin;%PATH%
When you wanna run LyX without installing from a out-of-source
When you want to run LyX without installing from an out-of-source
build directory you have to set the environment variable LYX_DIR_21x
and it must point to the lib dir in the source tree.
Linux/Unix: export LYX_DIR_21x=<lyx-source>/lib
Windows : set LYX_DIR_21x=<lyx-source>\lib
Windows specific
On Windows install the supplementary modules:
* Visual Studio 2008: ftp://ftp.lyx.org/pub/lyx/contrib/lyx-windows-deps-msvc2008.zip
* Visual Studio 2010: ftp://ftp.devel.lyx.org/pub/contrib/windows/bin
@ -35,7 +35,7 @@ Building LyX with CMake
<build-dir>\msvc2010-deps\deps20\ghostscript
<build-dir>\msvc2010-deps\deps20\gettext-tools
If cmake couldn't find these modules set GNUWIN32_DIR, eg.
If cmake couldn't find these modules set GNUWIN32_DIR, e.g.
-DGNUWIN32_DIR=c:\gnuwin32. By default cmake searches in your
program folder. Or use the cmake GUI to set the GNUWIN32_DIR path.
@ -43,9 +43,9 @@ Building LyX with CMake
in %ProgramFiles%/GnuWin32/ and in /usr/ or in /usr/local
under Linux. If it could not find aspell, spell checking
will be disabled.
Generating build system files
------------------------------
@ -58,48 +58,48 @@ Generating build system files
argument when running cmake selects this.
Building out-of-source
-----------------------
The standard way of using CMake is to build in a folder which doesn't resides
in the source tree. This has the advantage, that a complete fresh build could
be done by simply deleting all files in the build folder and to re-run cmake
The standard way of using CMake is to build in a folder that doesn't reside
in the source tree. This has the advantage that a complete fresh build could
be done by simply deleting all files in the build folder and re-running cmake
again.
Another benefit of out-of-source builds is that several builds (debug, release,
command-line builds, IDE project files) could all use the same source tree.
Therefore when using cmake create a folder outside of the source tree and
Therefore when using CMake create a folder outside of the source tree and
select this folder when using CMake's GUI, cmake-gui, or go into this folder
when you call cmake from the shell.
Before performing an out-of-source build, ensure that all CMake generated
in-source build information is removed from the source directory,
e.g., CMakeFiles directory, CMakeCache.txt.
e.g., CMakeFiles directory, CMakeCache.txt.
Using cmake
------------
When calling cmake you must pass the path to the source tree (absolute are relative)
and optionally the generator (each system has its own default). Additional arguments
When calling cmake you must pass the path to the source tree (absolute or relative)
and optionally the generator (each system has its own default). Additional arguments
could be passed with the -D prefix.
Here some examples, assuming the build folder is in the same folder as the source tree:
* Makefiles on Linux
cmake ../trunk
* Project files for QtCreator:
Open the trunk/CMakeLists.txt file and select the build folder
or create the files in the command line using the -G"CodeBlocks *" option, eg
cmake ../trunk -G"CodeBlocks - Unix Makefiles"
* Project files for Xcode
cmake ../trunk -GXcode
* Project files for Visual Studio 10
cmake ..\trunk -G"Visual Studio 10"
@ -121,19 +121,19 @@ Using cmake
* Unused source code file
Because cmake scans the directories for *.cpp and *.h files it will also
add files to the build system which are not mentioned to build. To exclude
add files to the build system that are not mentioned to build. To exclude
them change their ending and re-run cmake.
Build options
--------------
Options could be passed by the -D prefix when running cmake.
Available options will be listed on each cmake run.
-Dhelp=1 lists all available options:
# Available on all systems/compilers
-- LYX_CPACK = OFF : Use the CPack management (Implies LYX_INSTALL option)
-- LYX_INSTALL = OFF : Build install projects/rules (implies a bunch of other options)
@ -150,7 +150,7 @@ Build options
-- LYX_QUIET = OFF : Don't generate verbose makefiles
-- LYX_INSTALL_PREFIX = OFF : Install path for LyX
-- LYX_EXTERNAL_LIBINTL = ON : Use external libintl
# GCC specific
-- LYX_PROFILE = OFF : Build profile version
-- LYX_EXTERNAL_BOOST = OFF : Use external boost
@ -167,63 +167,63 @@ Build options
-- LYX_CONFIGURE_CHECKS = OFF : Also run configure checks for MSVC
-- LYX_DEPENDENCIES_DOWNLOAD= OFF : Download precompiled 3rd party libraries for MSVC 10
Using the merged files build
-----------------------------
When the option 'LYX_MERGE_FILES' is used then for each library a files
is generated which includes all source files of this library, this speeds
up compilation about factor 5.
When the option 'LYX_MERGE_FILES' is used then for each library a file
is generated that includes all source files of this library, this speeds
up compilation by a factor of about 5.
When you heavily work on one file you could comment out the relevant
When you heavily work on one file you could comment out the relevant
define in the '_allinone_const.C' file, so only the file _allinone_touched.C'
file will be re-compiled again an again.
will be re-compiled again and again.
- Adding new files
When you add new files the merging files have to be rebuild:
When you add new files the merging files have to be rebuilt:
cmake -DLYX_MERGE_REBUILD=1 .
Or start over by completely cleaning the build folder.
Or start over by completely cleaning the build folder.
- Starting over with same configuration
Delete all files but CMakeCache.txt and call
- Starting over with the same configuration
Delete all files except CMakeCache.txt and call
cmake .
Visual Studio C++
------------------
* Warnings: The default warning level of the msvc cmake builds
is /W3. To enable /W4 use
'-DLYX_WALL=1 '
and
and
'-DLYX_WALL=0'
switches back to to /W3,
switches back to to /W3.
To disable a specific warning add it to MSVC_W_DISABLE in
cmake/CMakeLists.txt. To make the warning an error add it
to MSVC_W_ERROR.
* Memory leak detection
For MSVC the usage of 'Visual Leak Detection' could be enabled
(http://dmoulding.googlepages.com/vld): -DLYX_VLD=1
Building vld requires the 'Debugging Tools For Windows' (~16MB)
http://www.microsoft.com/whdc/devtools/debugging/default.mspx
Eventually you have to copy dbghelp.dll from your Visual Studio
Common7\IDE folder into the binary directory.
Common7\IDE folder into the binary directory.
'vld.ini' is part of lyx.proj where you can configure vld.
The docu for vld could be found in development/Win32/vld, or
The documentation for vld can be found in development/Win32/vld, or
http://www.codeproject.com/tools/visualleakdetector.asp
Some tips:
* the Release build links much faster
* the Release build links much faster
* for the 'Debug' and 'Release' build all precompiled headers are enabled
to compile without pch (non file merge mode) This could be used to check
to compile without pch (non file merge mode) This could be used to check
if all necessary headers are included.
* use 'MinSizeRel' which only precompiles the STL and Boost headers
* use 'RelWithDebInfo' which does not use any precompiled headers
@ -238,18 +238,18 @@ GCC/Windows (Win2k only works with MSYS, XP?)
Ubuntu/Kubuntu
--------------_
---------------
You need additionally these packages:
* g++
* cmake
* qt4-dev-tools
Xcode/Mac
----------
Some tips:
* Xcode prefers UTF8 when opening source files, though LyX usually uses
@ -258,17 +258,17 @@ Xcode/Mac
* You can run and debug LyX from Xcode. For LyX to find its resources, there
are two possibilities:
a) Put a resource directory, e.g. a link to the lib directory of the
a) Put a resource directory, e.g. a link to the lib directory of the
source tree, at .../trunk/../build/bin/Resources
b) Select the lyx-qt4 executable in Xcode, click on "Get Info" in the
context menu and add "-sysdir a_valid_LyX_resource_directory"
context menu and add "-sysdir a_valid_LyX_resource_directory"
pointing e.g. to a valid Contents/Resources of a LyX.app directory.
* LyX on Mac doesn't look for fonts in the resource directory if the
executable is not in an .app bundle. Instead you have to create a
symbolic link to the fonts directory in the place where the executable
is: ln -s .../trunk/lib/fonts .../trunk/../build/bin/Debug/
If you don't do that math character will not show up correctly.
If you don't do that math characters will not show up correctly.
* CMake properly finds the Qt4 library bundles from Trolltech's binary
Qt4 package for Mac. So no need to compile Qt on your own.
@ -276,17 +276,17 @@ Xcode/Mac
Updating the translations
----------
--------------------------
Read README.localization for information on the translation process.
Here we list only the cmake specific part. As with the autotools build
Here we list only the CMake specific part. As with the autotools build
system the translations are only updated on demand.
- Update .po files and create .gmo files (does not touch the source tree):
make translations
- Copy the updated .po files into the source tree for committing:
make update-po
make update-po
- Update the layouttranslations file in the source tree:
make layouttranslations1
@ -309,6 +309,6 @@ Packaging
- Binary .rpm:
create : cpack -G RPM --config CPackConfig.cmake
list : rpm -qlp lyx-*.rpm
install: rpm -U lyx-*.rpm
list : rpm -qlp lyx-*.rpm
install: rpm -U lyx-*.rpm