Re: [RFC] [GSoC] Draft of Proposal for GSoC

From: Brian Bourn <ba.bourn@gmail.com>
Date: Mar 21, 2014, 18:03 UTC
Message-ID: <CAM+=D-D=PW=ZJFvc0y+Zhs8tPcbXnP-q4w-MeeLwT+t-QD_55w@mail.gmail.com>
In-Reply-To: <xmqq8us3v42o.fsf@gitster.dls.corp.google.com>

On Fri, Mar 21, 2014 at 1:45 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 19 quoted lines

> Brian Bourn <ba.bourn@gmail.com> writes:
>
>> Something like this?
>>
>> Sample api calls
>> Add_Opt_Group()
>> Parse_with_contains()
>> Parse_with_merged()
>> Parse_with_no_merged()
>> Parse_with_formatting()
>> (each of the 4 calls above may have internal calls within the library
>> in order to parse the option for each of the different function which
>> may call these functions)
>
> This list is a bit too sketchy to be called "sample api calls", at
> least to me.  Can you elaborate a bit more?
>
> What do they do, what does the caller expect to see (do they get
> something as return values?  do they expect some side effects?)?

so something like this would be better I'm assuming?

Some basic sample API calls are found below, each of these would hold code to complete parsing and/or formatting the flags. Add_Opt_Group() - returns an OPT_CALLBACK with contains, merged, no-merged, or formatting which can be used in a commands options list.

Execute_list()-the main call into the library and would pass into the library all of the necessary flags and arguments for parsing the request and executing it. This would accept the flags like -contain, with arguments such as the commit or pattern that is being searched for.

The next four commands would be called by execute_list() to execute the original command with respect to the flags that are passed into this library. Parse_with_contains() Parse_with_merged() Parse_with_no_merged() Parse_with_formatting()