From 243b92e934c433f925a3830b1e9f20294c6013c6 Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Thu, 22 Aug 2013 17:32:58 -0400 Subject: Typo --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 2a1dd1ca..43b6be1b 100644 --- a/README +++ b/README @@ -18,7 +18,7 @@ set of languages. Typelib ======= -The typelib is a to disk version of the GIR designed to be fast, memory +The typelib is an on-disk version of the GIR designed to be fast, memory efficient and complete enough so that language bindings can be written on top of it without other sources of information. It is normally compiled from a GIR when a library/program is installed and -- cgit v1.2.1 From 85a1b423bbd5bdc27c76c77d0b9d30174f05d6e2 Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Wed, 14 Aug 2013 23:48:16 +0200 Subject: g-ir-compiler: remove references to --code, remove --no-init options The "--code" option was removed years ago in ac81f3e8c5f1c380d16677232d67466e739da283 so remove references to it from README and g-ir-compiler(1) Remove the "--no-init" option from g-ir-compiler and g-ir-compiler(1) as it was documented to "can only be used if --code is also specified", so no reason to keep it around. --- README | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 43b6be1b..6f9ce75d 100644 --- a/README +++ b/README @@ -30,8 +30,7 @@ Tools Three tools are shipped with GObject Introspection: - g-ir-compile, a typelib compiler. It converts one or more GIR files - into one or more typelib blobs. It can either emit the raw typelib - blob or C code (--code). + into one or more typelib blobs. - g-ir-generate, an GIR generator, using the repository API. It generates GIR files from binary typelib which can be in a shared object, or a raw typelib blob. -- cgit v1.2.1 From fd6ebf476f9e55a4ea3b1e88abd05ce72eed1506 Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Thu, 2 May 2013 17:12:46 +0200 Subject: README: fix the Tools section a bit --- README | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'README') diff --git a/README b/README index 6f9ce75d..81f8614c 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ GObject Introspection ===================== -The goal of the project is to describe the APIs and collect them in +The goal of the project is to describe the APIs and collect them in a uniform, machine readable format. GIR XML format @@ -28,16 +28,17 @@ use the information. Tools ===== -Three tools are shipped with GObject Introspection: -- g-ir-compile, a typelib compiler. It converts one or more GIR files +The following tools are shipped with GObject Introspection: +- g-ir-scanner, a tool which generates GIR XML files by parsing headers, + GTK-Doc comment blocks including annotations and introspecting GObject + based libraries. +- g-ir-compiler, a typelib compiler. It converts one or more GIR files into one or more typelib blobs. - g-ir-generate, an GIR generator, using the repository API. It generates GIR files from binary typelib which can be in a shared object, or a raw typelib blob. -- g-ir-scanner, a tool which generates GIR XML files by parsing headers - and introspecting GObject based libraries. -- g-ir-doc-tool, generates Mallard files that can be viewed with yelp or - rendered to HTML with yelp-build from yelp-tools. +- g-ir-annotation-tool, extracts annotations from source code files +- g-ir-doc-tool, generates API reference documentation from a GIR XML file. API library =========== -- cgit v1.2.1