summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2015-05-10 08:19:38 -0700
committerEli Bendersky <eliben@gmail.com>2015-05-10 08:19:38 -0700
commitd69771ed0bc1a35500952b91c055e3051e095fb8 (patch)
tree1754f3a9ffecf7ea884d1d1a6df6c6352c0b47a6
parente9f5bc7c8a00e71df1255f8df15979336034fdaa (diff)
downloadpycparser-d69771ed0bc1a35500952b91c055e3051e095fb8.tar.gz
Various cosmetic updates to documentation
-rw-r--r--LICENSE2
-rw-r--r--README.rst19
-rw-r--r--examples/c-to-c.py2
-rw-r--r--examples/explore_ast.py2
-rw-r--r--pycparser/__init__.py2
-rw-r--r--pycparser/_ast_gen.py4
-rw-r--r--pycparser/_build_tables.py2
-rw-r--r--pycparser/_c_ast.cfg2
-rw-r--r--pycparser/ast_transforms.py2
-rw-r--r--pycparser/c_ast.py2
-rw-r--r--pycparser/c_generator.py2
-rw-r--r--pycparser/c_lexer.py2
-rw-r--r--pycparser/c_parser.py2
-rw-r--r--pycparser/plyparser.py2
14 files changed, 26 insertions, 21 deletions
diff --git a/LICENSE b/LICENSE
index 9a43338..d2333a5 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2012, Eli Bendersky
+Copyright (c) 2008-2015, Eli Bendersky
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
diff --git a/README.rst b/README.rst
index 0cafea7..037b1b6 100644
--- a/README.rst
+++ b/README.rst
@@ -36,10 +36,12 @@ Anything that needs C code to be parsed. The following are some uses for
One of the most popular uses of **pycparser** is in the `cffi
<https://cffi.readthedocs.org/en/latest/>`_ library, which uses it to parse the
declarations of C functions and types in order to auto-generate FFIs.
+
**pycparser** is unique in the sense that it's written in pure Python - a very
high level language that's easy to experiment with and tweak. To people familiar
-with Lex and Yacc, **pycparser**'s code will be simple to understand.
-
+with Lex and Yacc, **pycparser**'s code will be simple to understand. It also
+has no external dependencies (except for a Python interpreter), making it very
+simple to install and deploy.
Which version of C does pycparser support?
------------------------------------------
@@ -48,8 +50,9 @@ Which version of C does pycparser support?
ISO/IEC 9899). Some features from C11 are also supported, and patches to support
more are welcome.
-**pycparser** doesn't support any GCC extensions. See the `FAQ
-<https://github.com/eliben/pycparser/wiki/FAQ>`_ for more details.
+**pycparser** supports very few GCC extensions, but it's fairly easy to set
+things up so that it parses code with a lot of GCC-isms successfully. See the
+`FAQ <https://github.com/eliben/pycparser/wiki/FAQ>`_ for more details.
What grammar does pycparser follow?
-----------------------------------
@@ -126,14 +129,14 @@ it will interact with ``cpp`` for you, as long as it's in your PATH, or you
provide a path to it.
On the vast majority of Linux systems, ``cpp`` is installed and is in the PATH.
-If you're on Windows and don't have ``cpp`` somewhere, you can use the one
+If you're on Windows and don't have ``cpp`` anywhere, you can use the one
provided in the ``utils`` directory in **pycparser**'s distribution. This
``cpp`` executable was compiled from the `LCC distribution
<http://www.cs.princeton.edu/software/lcc/>`_, and is provided under LCC's
license terms.
Note also that you can use ``gcc -E`` or ``clang -E`` instead of ``cpp``. See
-the ``using_gcc_E_libc.py`` example for more details. Windows folks can download
+the ``using_gcc_E_libc.py`` example for more details. Windows users can download
and install a binary build of Clang for Windows `from this website
<http://llvm.org/releases/download.html>`_.
@@ -223,7 +226,9 @@ Contributors
Some people have contributed to **pycparser** by opening issues on bugs they've
found and/or submitting patches. The list of contributors is in the CONTRIBUTORS
-file in the source distribution.
+file in the source distribution. Once **pycparser** moved to Github, I stopped
+updating this list because Github does a much better job at tracking
+contributions.
CI Status
=========
diff --git a/examples/c-to-c.py b/examples/c-to-c.py
index a92aeee..6070108 100644
--- a/examples/c-to-c.py
+++ b/examples/c-to-c.py
@@ -4,7 +4,7 @@
# Example of using pycparser.c_generator, serving as a simplistic translator
# from C to AST and back to C.
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#------------------------------------------------------------------------------
from __future__ import print_function
diff --git a/examples/explore_ast.py b/examples/explore_ast.py
index aaaa9b1..3dd798e 100644
--- a/examples/explore_ast.py
+++ b/examples/explore_ast.py
@@ -9,7 +9,7 @@
# information from the AST.
# It helps to have the pycparser/_c_ast.cfg file in front of you.
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
from __future__ import print_function
diff --git a/pycparser/__init__.py b/pycparser/__init__.py
index ae2b999..0cc3f83 100644
--- a/pycparser/__init__.py
+++ b/pycparser/__init__.py
@@ -4,7 +4,7 @@
# This package file exports some convenience functions for
# interacting with pycparser
#
-# Copyright (C) 2008-2012, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
__all__ = ['c_lexer', 'c_parser', 'c_ast']
diff --git a/pycparser/_ast_gen.py b/pycparser/_ast_gen.py
index ddbfd67..bf9cb29 100644
--- a/pycparser/_ast_gen.py
+++ b/pycparser/_ast_gen.py
@@ -7,7 +7,7 @@
# The design of this module was inspired by astgen.py from the
# Python 2.5 code-base.
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
import pprint
@@ -150,7 +150,7 @@ r'''#-----------------------------------------------------------------
#
# AST Node classes.
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
diff --git a/pycparser/_build_tables.py b/pycparser/_build_tables.py
index e8b5478..151e594 100644
--- a/pycparser/_build_tables.py
+++ b/pycparser/_build_tables.py
@@ -6,7 +6,7 @@
# Also generates AST code from the configuration file.
# Should be called from the pycparser directory.
#
-# Copyright (C) 2008-2012, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
diff --git a/pycparser/_c_ast.cfg b/pycparser/_c_ast.cfg
index 5323e57..fad5691 100644
--- a/pycparser/_c_ast.cfg
+++ b/pycparser/_c_ast.cfg
@@ -9,7 +9,7 @@
# <name>** - a sequence of child nodes
# <name> - an attribute
#
-# Copyright (C) 2008-2012, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
diff --git a/pycparser/ast_transforms.py b/pycparser/ast_transforms.py
index 55b1608..36db1e8 100644
--- a/pycparser/ast_transforms.py
+++ b/pycparser/ast_transforms.py
@@ -3,7 +3,7 @@
#
# Some utilities used by the parser to create a friendlier AST.
#
-# Copyright (C) 2008-2012, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#------------------------------------------------------------------------------
diff --git a/pycparser/c_ast.py b/pycparser/c_ast.py
index d90ac36..4989f50 100644
--- a/pycparser/c_ast.py
+++ b/pycparser/c_ast.py
@@ -11,7 +11,7 @@
#
# AST Node classes.
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
diff --git a/pycparser/c_generator.py b/pycparser/c_generator.py
index 940c83f..f4a5a12 100644
--- a/pycparser/c_generator.py
+++ b/pycparser/c_generator.py
@@ -3,7 +3,7 @@
#
# C code generator from pycparser AST nodes.
#
-# Copyright (C) 2008-2012, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#------------------------------------------------------------------------------
from . import c_ast
diff --git a/pycparser/c_lexer.py b/pycparser/c_lexer.py
index ce53af0..cbb9d26 100644
--- a/pycparser/c_lexer.py
+++ b/pycparser/c_lexer.py
@@ -3,7 +3,7 @@
#
# CLexer class: lexer for the C language
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#------------------------------------------------------------------------------
import re
diff --git a/pycparser/c_parser.py b/pycparser/c_parser.py
index 11405ed..b10bba1 100644
--- a/pycparser/c_parser.py
+++ b/pycparser/c_parser.py
@@ -3,7 +3,7 @@
#
# CParser class: Parser and AST builder for the C language
#
-# Copyright (C) 2008-2013, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#------------------------------------------------------------------------------
import re
diff --git a/pycparser/plyparser.py b/pycparser/plyparser.py
index 210a5f8..7b86f56 100644
--- a/pycparser/plyparser.py
+++ b/pycparser/plyparser.py
@@ -4,7 +4,7 @@
# PLYParser class and other utilites for simplifying programming
# parsers with PLY
#
-# Copyright (C) 2008-2012, Eli Bendersky
+# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------