[Spice-devel] [PATCH 1/2] style: Sort abbreviations alphabetically

[Frediano Ziglio]

> 
> Acked-by: Christophe Fergeau <cfergeau at redhat.com>
> 
> (and as a side-note, we should actively fight against using these
> abbreviations)
> 
> Christophe
> 

Currently they are mostly used for variable like the standard
"int i" in C. There are some exceptions like dcc but really, it
became very long.

IMO as used in the code they should be documented so new coders
can understand code better but if we decide to avoid them
we can state this in the style document. This is the way usually
style change is done to avoid losing history.

I think methods (like using ccc->do_something() instead of
cursor_channnel_client_do_something(ccc)) and is-a relationship
(like foo(ccc) instead of foo(RED_CHANNEL(ccc))) are the most
thing I miss about C++.

Frediano

> On Wed, May 25, 2016 at 12:51:36PM +0100, Frediano Ziglio wrote:
> > Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> > ---
> >  docs/spice_style.txt | 8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/docs/spice_style.txt b/docs/spice_style.txt
> > index b024b6b..d7a879d 100644
> > --- a/docs/spice_style.txt
> > +++ b/docs/spice_style.txt
> > @@ -138,15 +138,15 @@ As a basic rule `Spice` refers to types in the public
> > external headers while `Re
> >  
> >  Common abbreviations
> >  ~~~~~~~~~~~~~~~~~~~~
> > -`rcc` RedChannelClient
> > -
> >  `dcc` DisplayChannelClient
> >  
> > -`sin` spice instance
> > +`dpi` drawable pipe item
> > +
> > +`rcc` RedChannelClient
> >  
> >  `sif` spice interface
> >  
> > -`dpi` drawable pipe item
> > +`sin` spice instance
> >  
> >  Optimization
> >  ------------
> > --
> > 2.7.4
> > 
> > _______________________________________________
> > Spice-devel mailing list
> > Spice-devel at lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/spice-devel
>