Skip to content

Commit

Permalink
Various cosmetic updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eliben committed May 10, 2015
1 parent e9f5bc7 commit d69771e
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 21 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
19 changes: 12 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?
------------------------------------------
Expand All @@ -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?
-----------------------------------
Expand Down Expand Up @@ -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>`_.

Expand Down Expand Up @@ -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
=========
Expand Down
2 changes: 1 addition & 1 deletion examples/c-to-c.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/explore_ast.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pycparser/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Expand Down
4 changes: 2 additions & 2 deletions pycparser/_ast_gen.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -150,7 +150,7 @@ def _gen_attr_names(self):
#
# AST Node classes.
#
# Copyright (C) 2008-2013, Eli Bendersky
# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion pycparser/_build_tables.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
#-----------------------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion pycparser/_c_ast.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
#-----------------------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion pycparser/ast_transforms.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
#------------------------------------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion pycparser/c_ast.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#
# AST Node classes.
#
# Copyright (C) 2008-2013, Eli Bendersky
# Copyright (C) 2008-2015, Eli Bendersky
# License: BSD
#-----------------------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion pycparser/c_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pycparser/c_lexer.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pycparser/c_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pycparser/plyparser.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
#-----------------------------------------------------------------

Expand Down

0 comments on commit d69771e

Please sign in to comment.