linux-sparse.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Franz Schrober <franzschrober@gmail.com>
To: linux-sparse@vger.kernel.org
Cc: sparse@chrisli.org, James Westby <james@jameswestby.net>,
	Franz Schrober <franzschrober@gmail.com>
Subject: [PATCH] Update the information in README about using the library.
Date: Tue,  3 Dec 2013 09:26:05 +0100	[thread overview]
Message-ID: <1386059165-3812-1-git-send-email-franzschrober@gmail.com> (raw)

From: James Westby <james@jameswestby.net>

Changes in the library have left the README giving out of date information
on how to intialise the library and get the symbols out of it. Update the
documentation to match the latest functions.

Signed-off-by: James Westby <james@jameswestby.net>
Signed-off-by: Franz Schrober <franzschrober@gmail.com>
---
This patch was already submitted by James Westby and had to be reverted again
after he didn't responded in the 4 year relicense process. Now he accepted the
change to MIT license and I just resubmit it for him. So it is a revert for the
revert 01b00f59f2a6aba6b623c0a68827938c1f570877 ('Revert "Update the
information in README about using the library."')

Sorry for the inconveniences.

 README | 29 ++++++++---------------------
 1 file changed, 8 insertions(+), 21 deletions(-)

diff --git a/README b/README
index a731a82..033ae15 100644
--- a/README
+++ b/README
@@ -47,35 +47,22 @@ requires the information.
 
 This means that a user of the library will literally just need to do
 
-	struct token *token;
-	int fd = open(filename, O_RDONLY);
-	struct symbol_list *list = NULL;
+  struct string_list *filelist = NULL;
+  char *file;
 
-	if (fd < 0)
-		exit_with_complaint();
+  action(sparse_initialize(argc, argv, filelist));
 
-	// Initialize parse symbols
-	init_symbols();
-
-	// Tokenize the input stream
-	token = tokenize(filename, fd, NULL);
-
-	// Pre-process the stream
-	token = preprocess(token);
-
-	// Parse the resulting C code
-	translation_unit(token, &list);

             reply	other threads:[~2013-12-03  8:26 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-12-03  8:26 Franz Schrober [this message]
2013-12-03 23:17 ` [PATCH] Update the information in README about using the library Christopher Li
2013-12-03 23:45   ` Josh Triplett
2013-12-04  0:12     ` Christopher Li
2013-12-09  9:21       ` Christopher Li
  -- strict thread matches above, loose matches on Subject: below --
2006-12-18 22:00 James Westby
2007-02-27 19:05 ` Josh Triplett

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1386059165-3812-1-git-send-email-franzschrober@gmail.com \
    --to=franzschrober@gmail.com \
    --cc=james@jameswestby.net \
    --cc=linux-sparse@vger.kernel.org \
    --cc=sparse@chrisli.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).