Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-22 Thread Pranith Kumar Karampuri
Here is my first draft of mem-pool data structure for review: 
http://review.gluster.org/8343

Please don't laugh at the ascii art ;-).

Pranith

On 07/17/2014 04:10 PM, Ravishankar N wrote:

On 07/15/2014 04:39 PM, Pranith Kumar Karampuri wrote:

hi,
  Please respond if you guys volunteer to add documentation for 
any of the following things that are not already taken.


client_t - pranith
integration with statedump - pranith
mempool - Pranith

event-hostory + circ-buff - Raghavendra Bhat
inode - Raghavendra Bhat

call-stub
fd
iobuf
graph
xlator
option-framework
rbthash
runner-framework
stack/frame
strfd
timer
store
gid-cache(source is heavily documented)
dict
event-poll




I'll take up event-poll. I have created an etherpad link with the 
components and volunteers thus far:

https://etherpad.wikimedia.org/p/glusterdoc
Feel free to update this doc with your patch details, other components 
etc.


- Ravi


Pranith
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-17 Thread Ravishankar N

On 07/15/2014 04:39 PM, Pranith Kumar Karampuri wrote:

hi,
  Please respond if you guys volunteer to add documentation for 
any of the following things that are not already taken.


client_t - pranith
integration with statedump - pranith
mempool - Pranith

event-hostory + circ-buff - Raghavendra Bhat
inode - Raghavendra Bhat

call-stub
fd
iobuf
graph
xlator
option-framework
rbthash
runner-framework
stack/frame
strfd
timer
store
gid-cache(source is heavily documented)
dict
event-poll




I'll take up event-poll. I have created an etherpad link with the 
components and volunteers thus far:

https://etherpad.wikimedia.org/p/glusterdoc
Feel free to update this doc with your patch details, other components etc.

- Ravi


Pranith
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-16 Thread Kaushal M
I'll take up documenting the options framework. I'd like take up graph
and dict, if Jeff doesn't mind.

Also, I think we should be aiming to document the complete API
provided by these components instead of just the data structure. That
would be more helpful to everyone IMO.

~kaushal

On Wed, Jul 16, 2014 at 11:21 AM, Raghavendra Gowdappa
rgowd...@redhat.com wrote:
 syncop-framework is not listed here. I would like to take that up. Also, if 
 nobody is willing to pick up runner framework, I can handle that too.

 - Original Message -
 From: Krutika Dhananjay kdhan...@redhat.com
 To: Pranith Kumar Karampuri pkara...@redhat.com
 Cc: Gluster Devel gluster-devel@gluster.org
 Sent: Wednesday, July 16, 2014 10:41:28 AM
 Subject: Re: [Gluster-devel] Developer Documentation for datastructures  
  in  gluster

 Hi,

 I'd like to pick up timer and call-stub.

 -Krutika




 From: Pranith Kumar Karampuri pkara...@redhat.com
 To: Gluster Devel gluster-devel@gluster.org
 Sent: Tuesday, July 15, 2014 4:39:39 PM
 Subject: [Gluster-devel] Developer Documentation for datastructures in
 gluster

 hi,
 Please respond if you guys volunteer to add documentation for any
 of the following things that are not already taken.

 client_t - pranith
 integration with statedump - pranith
 mempool - Pranith

 event-hostory + circ-buff - Raghavendra Bhat
 inode - Raghavendra Bhat

 call-stub
 fd
 iobuf
 graph
 xlator
 option-framework
 rbthash
 runner-framework
 stack/frame
 strfd
 timer
 store
 gid-cache(source is heavily documented)
 dict
 event-poll

 Pranith
 ___
 Gluster-devel mailing list
 Gluster-devel@gluster.org
 http://supercolony.gluster.org/mailman/listinfo/gluster-devel


 ___
 Gluster-devel mailing list
 Gluster-devel@gluster.org
 http://supercolony.gluster.org/mailman/listinfo/gluster-devel

 ___
 Gluster-devel mailing list
 Gluster-devel@gluster.org
 http://supercolony.gluster.org/mailman/listinfo/gluster-devel
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-16 Thread Niels de Vos
On Tue, Jul 15, 2014 at 04:39:39PM +0530, Pranith Kumar Karampuri wrote:
 hi,
   Please respond if you guys volunteer to add documentation for
 any of the following things that are not already taken.
 
 client_t - pranith
 integration with statedump - pranith
 mempool - Pranith
 
 event-hostory + circ-buff - Raghavendra Bhat
 inode - Raghavendra Bhat
 
 call-stub
 fd
 iobuf
 graph
 xlator
 option-framework
 rbthash
 runner-framework
 stack/frame
 strfd
 timer
 store

I'll take the store part.

Niels

 gid-cache(source is heavily documented)
 dict
 event-poll
 
 Pranith
 ___
 Gluster-devel mailing list
 Gluster-devel@gluster.org
 http://supercolony.gluster.org/mailman/listinfo/gluster-devel
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-16 Thread Pranith Kumar Karampuri


On 07/16/2014 11:57 AM, Kaushal M wrote:

I'll take up documenting the options framework. I'd like take up graph
and dict, if Jeff doesn't mind.

Also, I think we should be aiming to document the complete API
provided by these components instead of just the data structure. That
would be more helpful to everyone IMO.

Yes. Will keep that in mind while writing the documentation :-)

Pranith


~kaushal

On Wed, Jul 16, 2014 at 11:21 AM, Raghavendra Gowdappa
rgowd...@redhat.com wrote:

syncop-framework is not listed here. I would like to take that up. Also, if 
nobody is willing to pick up runner framework, I can handle that too.

- Original Message -

From: Krutika Dhananjay kdhan...@redhat.com
To: Pranith Kumar Karampuri pkara...@redhat.com
Cc: Gluster Devel gluster-devel@gluster.org
Sent: Wednesday, July 16, 2014 10:41:28 AM
Subject: Re: [Gluster-devel] Developer Documentation for datastructures   
in  gluster

Hi,

I'd like to pick up timer and call-stub.

-Krutika




From: Pranith Kumar Karampuri pkara...@redhat.com
To: Gluster Devel gluster-devel@gluster.org
Sent: Tuesday, July 15, 2014 4:39:39 PM
Subject: [Gluster-devel] Developer Documentation for datastructures in
gluster

hi,
Please respond if you guys volunteer to add documentation for any
of the following things that are not already taken.

client_t - pranith
integration with statedump - pranith
mempool - Pranith

event-hostory + circ-buff - Raghavendra Bhat
inode - Raghavendra Bhat

call-stub
fd
iobuf
graph
xlator
option-framework
rbthash
runner-framework
stack/frame
strfd
timer
store
gid-cache(source is heavily documented)
dict
event-poll

Pranith
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel

___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


[Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-15 Thread Pranith Kumar Karampuri

hi,
  Please respond if you guys volunteer to add documentation for any 
of the following things that are not already taken.


client_t - pranith
integration with statedump - pranith
mempool - Pranith

event-hostory + circ-buff - Raghavendra Bhat
inode - Raghavendra Bhat

call-stub
fd
iobuf
graph
xlator
option-framework
rbthash
runner-framework
stack/frame
strfd
timer
store
gid-cache(source is heavily documented)
dict
event-poll

Pranith
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-15 Thread Kaushal M
What do you mean by 'option-framework'? Is it the xlator options table
that we have in each xlator? Or the glusterd volume set framework
(which requires the xlator options tables to function anyway)?

On Tue, Jul 15, 2014 at 4:39 PM, Pranith Kumar Karampuri
pkara...@redhat.com wrote:
 hi,
   Please respond if you guys volunteer to add documentation for any of
 the following things that are not already taken.

 client_t - pranith
 integration with statedump - pranith
 mempool - Pranith

 event-hostory + circ-buff - Raghavendra Bhat
 inode - Raghavendra Bhat

 call-stub
 fd
 iobuf
 graph
 xlator
 option-framework
 rbthash
 runner-framework
 stack/frame
 strfd
 timer
 store
 gid-cache(source is heavily documented)
 dict
 event-poll

 Pranith
 ___
 Gluster-devel mailing list
 Gluster-devel@gluster.org
 http://supercolony.gluster.org/mailman/listinfo/gluster-devel
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-15 Thread Pranith Kumar Karampuri


On 07/15/2014 04:47 PM, Kaushal M wrote:

What do you mean by 'option-framework'? Is it the xlator options table
that we have in each xlator? Or the glusterd volume set framework
(which requires the xlator options tables to function anyway)?

options.c in libglusterfs

Pranith


On Tue, Jul 15, 2014 at 4:39 PM, Pranith Kumar Karampuri
pkara...@redhat.com wrote:

hi,
   Please respond if you guys volunteer to add documentation for any of
the following things that are not already taken.

client_t - pranith
integration with statedump - pranith
mempool - Pranith

event-hostory + circ-buff - Raghavendra Bhat
inode - Raghavendra Bhat

call-stub
fd
iobuf
graph
xlator
option-framework
rbthash
runner-framework
stack/frame
strfd
timer
store
gid-cache(source is heavily documented)
dict
event-poll

Pranith
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-15 Thread Justin Clift
On 15/07/2014, at 1:45 PM, Jeff Darcy wrote:
   Please respond if you guys volunteer to add documentation for any
 of the following things that are not already taken.
 
 I think the most important thing to describe for each of these is the
 life cycle rules.  When I've tried to teach people about translators,
 one of the biggest stumbling blocks has been the question of what gets
 freed after the fop, what gets freed after the callback, and what lives
 on even longer.  There are different rules for dict_t, loc_t, inode_t,
 etc.  Dict_set_*str is one of the worst offenders; even after all this
 time, I have to go back and re-check which variants do what when the
 dict itself is freed.  If the only thing that comes out of this effort
 is greater clarity regarding what should be freed when, it will be
 worth it.

+1 :)

--
GlusterFS - http://www.gluster.org

An open source, distributed file system scaling to several
petabytes, and handling thousands of clients.

My personal twitter: twitter.com/realjustinclift

___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-15 Thread Niels de Vos
On Tue, Jul 15, 2014 at 08:45:45AM -0400, Jeff Darcy wrote:
 Please respond if you guys volunteer to add documentation for any
  of the following things that are not already taken.
 
 I think the most important thing to describe for each of these is the
 life cycle rules.  When I've tried to teach people about translators,
 one of the biggest stumbling blocks has been the question of what gets
 freed after the fop, what gets freed after the callback, and what lives
 on even longer.  There are different rules for dict_t, loc_t, inode_t,
 etc.  Dict_set_*str is one of the worst offenders; even after all this
 time, I have to go back and re-check which variants do what when the
 dict itself is freed.  If the only thing that comes out of this effort
 is greater clarity regarding what should be freed when, it will be
 worth it.
 
  client_t - pranith
  integration with statedump - pranith
  mempool - Pranith
  
  event-hostory + circ-buff - Raghavendra Bhat
  inode - Raghavendra Bhat
  
  call-stub
  fd
  iobuf
  graph
  xlator
  option-framework
  rbthash
  runner-framework
  stack/frame
  strfd
  timer
  store
  gid-cache(source is heavily documented)
  dict
  event-poll
 
 My Translator 101 series already covers xlators and call frames,
 so I might as well continue with those.

Can you make these available in MarkDown format somewhere under the 
docs/ directory?

Thanks,
Niels
___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel


Re: [Gluster-devel] Developer Documentation for datastructures in gluster

2014-07-15 Thread Pranith Kumar Karampuri


On 07/15/2014 07:22 PM, Niels de Vos wrote:

On Tue, Jul 15, 2014 at 08:45:45AM -0400, Jeff Darcy wrote:

Please respond if you guys volunteer to add documentation for any
of the following things that are not already taken.

I think the most important thing to describe for each of these is the
life cycle rules.  When I've tried to teach people about translators,
one of the biggest stumbling blocks has been the question of what gets
freed after the fop, what gets freed after the callback, and what lives
on even longer.  There are different rules for dict_t, loc_t, inode_t,
etc.  Dict_set_*str is one of the worst offenders; even after all this
time, I have to go back and re-check which variants do what when the
dict itself is freed.  If the only thing that comes out of this effort
is greater clarity regarding what should be freed when, it will be
worth it.


client_t - pranith
integration with statedump - pranith
mempool - Pranith

event-hostory + circ-buff - Raghavendra Bhat
inode - Raghavendra Bhat

call-stub
fd
iobuf
graph
xlator
option-framework
rbthash
runner-framework
stack/frame
strfd
timer
store
gid-cache(source is heavily documented)
dict
event-poll

My Translator 101 series already covers xlators and call frames,
so I might as well continue with those.

Can you make these available in MarkDown format somewhere under the
docs/ directory?

Oops sorry. That is what we are going to do. Send patches :-).

Pranith.


Thanks,
Niels


___
Gluster-devel mailing list
Gluster-devel@gluster.org
http://supercolony.gluster.org/mailman/listinfo/gluster-devel