aboutsummaryrefslogtreecommitdiffstats
path: root/tools/pidl/README
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2014-09-26 12:02:05 -0700
committerGuy Harris <guy@alum.mit.edu>2014-09-26 19:02:42 +0000
commitbcae0488fc09cbb264b1a816be74e5e0721847b3 (patch)
tree88b34df778b4a51d292a249b5e6a4f9b59ca9129 /tools/pidl/README
parentc90acf26f88411e62f4200032665f570fe1675c6 (diff)
Update to the latest version from the Samba Git repository.
From the Samba log: commit bfdc874e8b98c8ea147dbcc986f96ad4f73d800f Author: Jelmer Vernooij <jelmer@samba.org> Date: Sat Aug 30 01:59:26 2014 +0200 Various updates to the pidl README file. Remove samba3/samba4-specific comments, add comments about backends and files. Change-Id: Id2253ce85eab7a684b2c50d25f6f2604dc146a8e Signed-Off-By: Jelmer Vernooij <jelmer@samba.org> Reviewed-by: David Disseldorp <ddiss@samba.org> Autobuild-User(master): David Disseldorp <ddiss@samba.org> Autobuild-Date(master): Sun Aug 31 23:47:49 CEST 2014 on sn-devel-104 commit 6824f1aa67f0a75df5c94921e334c2b7c7771611 Author: Jelmer Vernooij <jelmer@samba.org> Date: Sat Aug 30 01:59:25 2014 +0200 Remove trailing whitespace. Change-Id: I1e0948da34bac278edc62cd63dedd08112426e7a Signed-Off-By: Jelmer Vernooij <jelmer@samba.org> Reviewed-by: David Disseldorp <ddiss@samba.org> Change-Id: Ifd445bf32aca2d30a6e501fc8c8dd030471ad284 Reviewed-on: https://code.wireshark.org/review/4312 Reviewed-by: Guy Harris <guy@alum.mit.edu>
Diffstat (limited to 'tools/pidl/README')
-rw-r--r--tools/pidl/README35
1 files changed, 18 insertions, 17 deletions
diff --git a/tools/pidl/README b/tools/pidl/README
index c6b7e11792..240a07a96e 100644
--- a/tools/pidl/README
+++ b/tools/pidl/README
@@ -1,31 +1,31 @@
Introduction:
=============
-This directory contains the source code of the pidl (Perl IDL)
-compiler for Samba 4.
+This directory contains the source code of the pidl (Perl IDL)
+compiler for Samba 4.
The main sources for pidl are available using Git as part of
-the combined Samba 3 / Samba 4 tree. Use:
+the Samba source tree. Use:
git clone git://git.samba.org/samba.git
-Pidl works by building a parse tree from a .pidl file (a simple
-dump of it's internal parse tree) or a .idl file
-(a file format mostly like the IDL file format midl uses).
-The IDL file parser is in idl.yp (a yacc file converted to
+Pidl works by building a parse tree from a .pidl file (a simple
+dump of it's internal parse tree) or a .idl file
+(a file format mostly like the IDL file format midl uses).
+The IDL file parser is in idl.yp (a yacc file converted to
perl code by yapp)
-After a parse tree is present, pidl will call one of it's backends
-(which one depends on the options given on the command-line). Here is
-a list of current backends:
-
Standalone installation:
========================
-Run Makefile.PL to generate the Makefile.
+Run Makefile.PL to generate the Makefile.
Then run "make install" (as root) to install.
Internals overview:
===================
+After a parse tree is present, pidl will call one of it's backends
+(which one depends on the options given on the command-line). Here is
+a list of current backends:
+
-- Generic --
Parse::Pidl::Dump - Converts the parse tree back to an IDL file
Parse::Pidl::Samba4::Header - Generates header file with data structures defined in IDL file
@@ -55,9 +55,10 @@ Parse::Pidl::Util - Misc utility functions used by *.pm and pidl.pl
Parse::Pidl::Typelist - Utility functions for keeping track of known types and their representation in C
Tips for hacking on pidl:
- - Look at the pidl's parse tree by using the --keep option and looking
- at the generated .pidl file.
- - The various backends have a lot in common, if you don't understand how one
- implements something, look at the others
+ - Inspect pidl's parse tree by using the --keep option and looking at the
+ generated .pidl file.
+ - The various backends have a lot in common, if you don't understand how one
+ implements something, look at the others.
- See pidl(1) and the documentation on midl
- - See 'info bison' and yapp(1) for information on the file format of idl.yp
+ - See 'info bison' and yapp(1) for information on the file format of idl.yp
+ - Run the tests (all in tests/)