Fix a couple (value) mistakes in value_strings. Found by Martin's patch on the ...

[obnox/wireshark/wip.git] / README.cmake

diff --git a/README.cmake b/README.cmake
index 8ec0045441d03cf16bf6ec1b1b4f4edd38a6acb9..e085ce33d7310b21a55533399e27afc543449a80 100644 (file)
--- a/README.cmake
+++ b/README.cmake
@@ -4,11 +4,8 @@
 
                            Notice 
 
-   The CMake build system for Wireshark is not yet ready for
-   building the whole system. You'll still need autofoo to buld it.
-   The only thing that can be build is dumpcap, and even that one
-   requires that you successfully ran autofoo prior to running cmake
-   (e.g. config.h is not yet build, lex and yacc are not run).
+   To find out the current state of the cmake implementaion for
+   Wireshark, please take a look at "What needs to be done?" below.
    Basically this is an experiment and if we find out that it works
    and we like cmake more than autofoo we might switch one day.
 
@@ -31,21 +28,34 @@ in tree builds do not work properly in all cases.
 
 How to do out of tree build (Unix/Linux):
 1) Install cmake.
-2) Build the project with the old build system once (to generate
-   config.h and run bison and flex to generate some c-files).
-3) Assuming, you are in the top directory of the wireshark source
+2) Assuming, you are in the top directory of the wireshark source
    cd ..
-4) mkdir build
-5) cd build
-6) cmake ../<Name_of_WS_source_dir>
-7) make
+3) mkdir build
+4) cd build
+5) cmake ../<Name_of_WS_source_dir>
+6) make
+
+Note 1:
+in step 5), you may override the defaults for features:
+ cmake -DENABLE_CAP=OFF ../<Name_of_WS_source_dir>
+ will disable the capabilities check.
+
+Note 2:
+ On OS X, you may want to run cmake like this:
+ cmake -DENABLE_CAP=OFF -G "Unix Makefiles"
+
+Note 3:
+  After running cmake, you can always run "make help" to see
+  a list of all possible make targets.
 
 Why cmake?
 ==========
 - Can create project files for some MS and Apple IDEs.
 - Fast
 - Easier to understand/learn
-- One build infrastructure even including Windows?
+- Doesn't create any files in the source tree in case
+  of out of tree builds
+- One build infrastructure even including Windows
 ...
 
 Why not cmake?
@@ -58,18 +68,31 @@ Why not cmake?
   cmake really works).
 ...
 
-What needs to be done?
-======================
+What works?
+===========
 
-only dumpcap and libwiretap have been done, and even those rely on
-autofoo having been run before:
+All the executables now build from clean source on:
+* 32bit openSUSE 11.3: (gnu)make and gcc
+* 64bit FedoraXXX
+* 32bit Ubuntu 9.04
+* 32bit Ubuntu 10.04
 
-- Add proper GTK1/GLIB2/GLIB1 detection (currently links against gtk2
-  to pull in glib2).
-- Create config.h
-- Autocreated source files in wiretap need to be build from .l, .y files.
+What needs to be done?
+======================
 
-All other tools and libs still need to be built.
+- Add asn1 autogen target (assigned: krj)
+- Add back platform specific objects.
+- Fix places in the cmake files marked as todo.
+- Add back (working) install target.
+  Currently, directories are created with user umask.
+  Also the guides are not installed.
+- Build source package (using CPack).
+- Build rpm package (using CPack).
+- Build dpkg package (using CPack).
+- Add back checkAPI target.
+- Test and add support for other platforms (BSDs, OSX,
+  Solaris, Win32, Win64, ...)
+...
 
 Links regarding cmake
 =====================
@@ -82,6 +105,9 @@ The home page of the cmake project documentation
 About cmake in general and why KDE4 uses it
        http://lwn.net/Articles/188693/
 
+Introductory/tutorial presentation
+       http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
+
 Introductory arcticle in Linux Journal
        http://www.linuxjournal.com/node/6700/print