diff mbox

[12/12] README: Add quick_dump info

Message ID 1360262377-24179-12-git-send-email-ben@bwidawsk.net (mailing list archive)
State New, archived
Headers show

Commit Message

Ben Widawsky Feb. 7, 2013, 6:39 p.m. UTC
Signed-off-by: Ben Widawsky <ben@bwidawsk.net>
---
 README | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Paul Menzel Feb. 7, 2013, 11:18 p.m. UTC | #1
Am Donnerstag, den 07.02.2013, 10:39 -0800 schrieb Ben Widawsky:

Thank you for updating documentation!

> Signed-off-by: Ben Widawsky <ben@bwidawsk.net>
> ---
>  README | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/README b/README
> index 0ec53fb..5ede794 100644
> --- a/README
> +++ b/README
> @@ -75,6 +75,21 @@ tools/
>  	These tools generally must be run as root, safe for the ones that just
>  	decode dumps.
>  
> +tools/quick_dump
> +	Quick dumper is a python tool built with SWIG bindings to
> +	important libraries exported by the rest of the tool quite. The tool

*s*uite

> +	itself is quite straight forward, and should also be a useful example
> +	for others wishing to write python based i915 tools.
> +
> +	As of writing, the build is sort of broken in Arch because of

Arch Linux distribution [add URL]

> +	the way they package Python. You'll need something like:
> +	LDFLAGS="-lpython3.3m"
> +
> +	Note to package maintainers: It is not recommended to package
> +	this directory, as the tool is not yet designed for such usage. If the

*wide* usage?

> +	package is installed via "make install" the user will have to

s,the user/users/

> +	set their python library path appropriately.
> +
>  debugger/
>  	This tool is to be used to do shader debugging. It acts like a
>  	debug server accepting connections from debug clients such as

With the above changes (proofread by a native English speaker)

Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>


Thanks,

Paul
Ben Widawsky Feb. 7, 2013, 11:48 p.m. UTC | #2
On Fri, Feb 08, 2013 at 12:18:31AM +0100, Paul Menzel wrote:
> Am Donnerstag, den 07.02.2013, 10:39 -0800 schrieb Ben Widawsky:
> 
> Thank you for updating documentation!
> 
> > Signed-off-by: Ben Widawsky <ben@bwidawsk.net>
> > ---
> >  README | 15 +++++++++++++++
> >  1 file changed, 15 insertions(+)
> > 
> > diff --git a/README b/README
> > index 0ec53fb..5ede794 100644
> > --- a/README
> > +++ b/README
> > @@ -75,6 +75,21 @@ tools/
> >  	These tools generally must be run as root, safe for the ones that just
> >  	decode dumps.
> >  
> > +tools/quick_dump
> > +	Quick dumper is a python tool built with SWIG bindings to
> > +	important libraries exported by the rest of the tool quite. The tool
> 
> *s*uite
> 
> > +	itself is quite straight forward, and should also be a useful example
> > +	for others wishing to write python based i915 tools.
> > +
> > +	As of writing, the build is sort of broken in Arch because of
> 
> Arch Linux distribution [add URL]
> 
> > +	the way they package Python. You'll need something like:
> > +	LDFLAGS="-lpython3.3m"
> > +
> > +	Note to package maintainers: It is not recommended to package
> > +	this directory, as the tool is not yet designed for such usage. If the
> 
> *wide* usage?
> 
> > +	package is installed via "make install" the user will have to
> 
> s,the user/users/
> 
> > +	set their python library path appropriately.
> > +
> >  debugger/
> >  	This tool is to be used to do shader debugging. It acts like a
> >  	debug server accepting connections from debug clients such as
> 
> With the above changes (proofread by a native English speaker)
> 
> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
> 
> 
> Thanks,
> 
> Paul

Thank you, Paul. I have absorbed all your requests, and added your r-b.
diff mbox

Patch

diff --git a/README b/README
index 0ec53fb..5ede794 100644
--- a/README
+++ b/README
@@ -75,6 +75,21 @@  tools/
 	These tools generally must be run as root, safe for the ones that just
 	decode dumps.
 
+tools/quick_dump
+	Quick dumper is a python tool built with SWIG bindings to
+	important libraries exported by the rest of the tool quite. The tool
+	itself is quite straight forward, and should also be a useful example
+	for others wishing to write python based i915 tools.
+
+	As of writing, the build is sort of broken in Arch because of
+	the way they package Python. You'll need something like:
+	LDFLAGS="-lpython3.3m"
+
+	Note to package maintainers: It is not recommended to package
+	this directory, as the tool is not yet designed for such usage. If the
+	package is installed via "make install" the user will have to
+	set their python library path appropriately.
+
 debugger/
 	This tool is to be used to do shader debugging. It acts like a
 	debug server accepting connections from debug clients such as