(file) Return to readme.pulloperations CVS log (file) (dir) Up to [Pegasus] / pegasus

  1 karl  1.1.2.1         Using the CIM/XML Pull Operations
  2               
  3               STATUS
  4               
  5 karl  1.1.2.4 <<< The TODO section is being maintained during the review and checkin process
  6 karl  1.1.2.1 to keep track of problems, errors, notes, etc.  Must be deleted before
  7               checkin to head of tree. Please feel free to add notes, etc in this
  8               section as you review/test.>>>>>>
  9               
 10 karl  1.1.2.4 TODO list:
 11 karl  1.1.2.3    1. Binary operation from OOP.  Need to add counter to binary
 12                     protocol to be able to count objects in response. Generates
 13                     warnings in things like messageserializer and does not work with
 14 karl  1.1.2.14       OOP right now.  Corrected by converting to XML. 
 15 karl  1.1.2.23    2. OpenExecQuery - Code is incomplete in that it does not include the
 16 karl  1.1.2.15       return from the exec query function to the aggregator yet.
 17 karl  1.1.2.4     3. Code for Pull part of OpenQueryInstancesRequest a) should be part of
 18                      the common CIMOperationRequestDispatcher execCommon code.
 19                   4. The changes to WQLCIMOperationRequestDispatcher and CQL... for handling
 20                      pull not completed so we feed the responses back to the EnmerationContext
 21                      queues
 22 karl  1.1.2.18    3. Lots of minor TODOs, diagnostics, etc. still in the code
 23 karl  1.1.2.14    4. External runtime variables. Proposing that they be fixed for this release
 24 karl  1.1.2.15       rather than set by configuration.  This should be discussed.  Am making
 25 karl  1.1.2.16       this a separate bug.  See bug 9819 for the changes to cover this.
 26 karl  1.1.2.24    5. Consider moving some more of the code in dispatcher from templates to
 27 karl  1.1.2.23       common functions which would mean adding intermediate classes in
 28                      CIMMessage but would reduce code size. Currently the change that
 29                      we should make for this is to create a new message CIMPullRequestData...
 30                      between CIMRequestDataMessage and the Pull requests since they all
 31                      have exactly the same input and output pararameters (The
 32                      CIMResponseData hides the response object differences)
 33                   6. Extension to avoid double move of objects in CIMResponseData (one
 34 karl  1.1.2.3        into enumerationContext queue and second to new cimResponseData for
 35                      response.  Want to avoid second move by extending Open/Pull response
 36                      messages to include count and CIMResponse data to count objects out
 37 karl  1.1.2.23       of queue when converting (avoids the second move). This would mean
 38                      extending the output writers to allow the count field to be supplied
 39                      so they would only create output for up to the count supplied.
 40 karl  1.1.2.26    9. Add more static tests (currently only OpenEnumerateInstances is covered).
 41                      Low priority because most of this except exact XML covered in other
 42                      tests.
 43                   10. Could clean up the CIMOperationRequestDecoder.cpp rejectCIMException
 44 karl  1.1.2.23       further since there is some overlap.  That is low priority.
 45 karl  1.1.2.26    12.Add exception for to many entries in EnumerationContextTable. The
 46 karl  1.1.2.23       test exists but is ignored right now.
 47 karl  1.1.2.26    12. Correct issue between operations and HTTP where we are sending
 48                      trailers with exceptions.  Also correct issue where we are
 49                      sending endOfSequence and EnumerationContext in response when
 50                      we send CIMException.
 51                
 52                   NEXT TASKS: 
 53 karl  1.1.2.23       b. Finish and test the OpenQueryInstances
 54 karl  1.1.2.16       c. Clean up TODOs
 55 karl  1.1.2.23       d. Find issue that is causing occasional failures under load.  It
 56                         is probably a threading issue between the 3 possible threads
 57                	 that use the EnumerationContext (request thread, provider thread,
 58 karl  1.1.2.24 	 timeout thread) and a place where not mutuxed, primarily the
 59                	 timeout thread.
 60 karl  1.1.2.23 
 61 karl  1.1.2.24 22 April 2014
 62                1. Clean up some messages.
 63                2. Still trying to find issue that randomly keeps messages in timeout
 64                   queue long after they have been closed and returned.
 65 karl  1.1.2.25 3. Fixed memory loss error.
 66 karl  1.1.2.26 4. Added zero reject for OperationTimeout because that effectively disables
 67                   the whole timeout mechanism so that enumerations could be started, never
 68                   completed by the client and would just hang around in memory. That
 69                   would be a significant DDOS attack (start very large enum with no
 70                   timeout) and never do pulls after open.
 71 karl  1.1.2.25 
 72 karl  1.1.2.23 21 April 2014
 73                1. Reorganizzed code in CIMOperationRequestDecoder.cpp ...Iparam classes.
 74                   Cleaned up the rejectCIMException code.
 75                2. Cleanup some issues in the EnumerationContextTimeout Thread.
 76                3. Fixed issue in pullop where it was using zero as default for default
 77                   operation timeout where it should have been NULL, the DMTF specified
 78                   default.
 79                4. Enabled the test to reject 0 as operation timeout on a request and but
 80                   controled by a #define in CIMOperationRequestDispatcher.cpp
 81                5. Added test for excessive new OperationContext entries in table.
 82                
 83                18 April 2014
 84                1. Internationalize remaining messages in CIMOperationRequestDecoder.cpp and
 85                   clean up the decoders for some of the messages so they use the
 86                   ...Iparam classes.  Note that we did not clean up all of the old message
 87                   decoders, just the new ones and we did not clean up the Count message
 88                   since it is deprecated. TODO clean these up so the decoder is really
 89                   consistent.
 90                2. Enabled the EnumerationContext Timer and removed code for alternate
 91                   non-thread solution.
 92 karl  1.1.2.16 
 93 karl  1.1.2.21 17 April 2014
 94                1. Reorganized the lock/unlock for handling the EnumerationContext because
 95                   there were thread windows (i.e. using the context after it was released
 96                   by other thread).
 97                2. Modified code for the InteroperationTimerThread and deleted old code that
 98                   allowed this whole thread to by bypassed.
 99                3. Internationalized a number of CIMOperationRequestDispatcher CIMException
100                   response messages.
101 karl  1.1.2.22 4. Fixed stress tests in Client/tests/pullop that were getting timeout. The
102                   issue was not the pull code but that fact that the idle client timeout
103                   appears to be measureing to the end of the operation and the operation
104                   was taking more than 40 seconds which is the default timeout. The idle
105                   timeout takes no account of the fact that chunks are being regularly
106                   delivered.
107                5. Several minor code changes.
108                NOTE: At this point the code passes extensive tests of the pull operations
109                   both in OOP and none OOP mode (but with lots of diagnostics that may
110                   be affecting timing).
111 karl  1.1.2.21 
112 karl  1.1.2.20 10 April 2014
113                1. Fix issues causing failure with repeated pull operations.
114                2. Consolidate some of the CIMOperationRequestDispatcher.cpp template code
115                
116 karl  1.1.2.19 7 April 2104
117                  MergeOut of head of tree.
118                
119                7 April 2014
120                1. Permanently fixed issue with getting correct number of objects on response.
121                   This was introduced when did a temp fix to the OOP processing, in particular
122                   removed the condition variable wait in the CIMOperationDispatcher handle
123                   functions for opens and pulls.  This moved the functionality to kick off
124                   open and pull responses to the provider threads if there are not enough
125                   objects when the handle is processed. Also added a variable to allow us to
126                   test with either a) responses are required to satisfy the original 
127                   request size or) b, responses are required only to return some objects.
128                   We will add statistics to see which of these works best.
129                2. Modified WsmProcessor EnumerationContext class since the name conflicts
130                   with the pull Operation EnumerationContext class.
131                3. Created a new intermediate level of CIMMessage, the CIMPullResponseData
132                   Message so that all of the open and Pull responses can use common code
133                   since there are only two variables (endOfSequence and EnumerationContext)
134                   and they are common across all the open and pull responses.
135                4. Removed a number of diagnostics.
136                5. Cleaned up the Dispcatcher so that the open and pulls have common response
137 karl  1.1.2.19    code and that code can be used from the dispatcher handle functions and
138                   the provider response functions.
139                
140 karl  1.1.2.18 31 March 2014 - Checkin
141                1. Fixed issues in OOP processing of pull operations, in particular
142                   issues with cimxml output format when processed through the
143                   *InternalXmlEncoder functions.
144                2. Clean up some of the internalXml functionality
145                3. Found issues causing timeout with a particular provider.  The issue
146                   is that the dispatcher and monitor end up using the same thread so the
147                   condition variable in the dispatcher thread stops the monitor. Turned
148                   off the conditionVariable in getCache for the moment which means that
149                   we get number of responses for open... with 0 objects before the
150                   providers can begin to respond.  This is only for test.
151                4. Added some statistics for enumerations and display the statistics 
152                   when we close the server (same as cache statistics)
153                
154                12 March 2014 - Mergeout and Mergein
155                1. Mergeout to head of tree for this date and mergein for patch update
156                   to bug 9676
157                2. Extensions to pullop tests program and tests.
158                3. Added some diagnostics in looking for OOP issue.
159                4. Removed a number of diagnostics messages and cleaned up code in
160                   dispatcher to simplify pull operation processing.
161 karl  1.1.2.18 
162 karl  1.1.2.17 15 December 2013
163                1. Mergeout and mergein up to 15 December 2013
164                2. Clean up issues from tests documented in bug 9676 last week.
165                3. Clean up some code in dispatcher
166                4. Remove the filter function from ResponseStressc++Provider.
167                
168 karl  1.1.2.16 21 November 2013
169                1. Mergeout from head of tree to 21 November 2013.
170 karl  1.1.2.15 
171                18 November 2013
172                1. Cleanup of a bunch of minor errors and completion of all of the code for
173                   the openQueryInstances except for the PullInstances in Dispatcher and
174                   the aggregator function.
175                2. OpenqueryInstances added to cimcli.
176 karl  1.1.2.14 
177                13 October 2013 CVS branch update.
178                1. Integrated bug 9786 into the branch.  Note that we need to test the
179                   generated statistics.
180                2. Mergeout executed to update to head of tree as of 8:00 am 13 October 2013.
181                3. Cleaned up several errors in OOP processing.  Note that there is at least
182                   one issue left when we to a pull on ManagedElement in at least one of the
183                   namespaces.
184                4. Cleaned up some of the outstanding diagnostic code
185                5. Generally passes all tests except for one test of pullop where it is trying
186                   to pull enum instances CIM_ManagedElement from a particular namespace.
187 karl  1.1.2.12 
188 karl  1.1.2.16 NOTE: I did not make comments here for changes in October despite the fact
189                that I did 2 mergouts, number of fixes, and a mergein.
190                
191 karl  1.1.2.12 30 September 2013 - CVS Update
192                Mergeout head of tree up to 29 September 2013.
193 karl  1.1.2.10 
194                29 September 2013. CVS update.
195                1. Modified calls to statisticalData.cpp to a) directly call with request
196                   type, b) incorporate the open, pull, etc. messages.  However, since these
197                   are not part of the CIM class, we must do something special with them.
198 karl  1.1.2.13    See bug 9785 for full solution to this issue.
199 karl  1.1.2.10 2. Corrected OOP interface to enable new flag to indicate internal operations
200                   and set host, etc.
201                3. Add code to CQLOperationsDispatcher and WQLOperationDispatcher to clean
202                   up CIMResponseDataCounter after filtering.
203                4. Modified ProviderAgent to set Host info for some pull operations.
204                5. Added new flag to CIMBinMsgSerializer and Deserializer.
205 karl  1.1.2.8  
206 karl  1.1.2.9  17 September 2013 CVS update (Actually two different updates over 3 days)
207                1. Clean up some issues in CIMMessage.h and CIMMessage.cpp
208                2. Extend OpenExecQuery to WQL and CQL processors but return not complete
209                3. Remove memory leak in EnumerationContext and EnumerationContextTable
210                   handling.
211                4. Created template functions for much of the pull operations.
212                5. Reversed order of queryLanguage and query (and changed names to match
213                   execQuery) in client and server.  Note that these are the execQuery
214                   WQL and CQL filters and NOT FQL filters.
215                6. Some code cleanup in dispatcher
216                7. Today, passes all tests in pullop but issue in alltests. For some reason
217                   not finding CIMObjectManager instance. Also, leaves enumeration contexts
218                   if client terminates since cleanup thread not operating.
219 karl  1.1.2.11 8. XML from OOP not correctly processed.
220 karl  1.1.2.9  
221 karl  1.1.2.8  14 September 2013 CVS update
222                Merged out up to 25 August.  Cleaned up all operations and standardized code.
223                At this point the non pull operations code is in a set of templates but the
224                pull is not yet.
225                Fixed a significant number of problems so that it appears that the operations
226                except for OpenExecQuery run stably, at least with the pullop test program.
227                Note that there is a problem in that the Interop control provider is not
228                returning its singleton wbemserver object for some reason.  Causes a test
229                failure
230 karl  1.1.2.7  
231                Fixed for 16 June CVS Update
232                   1. Cleaned up the enumerationContext and Table release functions and tested
233                      to confirm that we do not lose memory in either normal sequences or
234                      sequences that close early. Cleaned up pullop and added more tests
235 karl  1.1.2.8  Taged Before: PREAUG25UPDATE and after POSTAUG25UPDATE
236 karl  1.1.2.4  
237                Fixed for 9 June CVS update
238                   1. Cleaned up code for OpenQueryInstances.  Note that this is incomplete.
239                      No support in WQL or CQL Operations
240                   2. 
241                
242                What was fixed for 5 June checkin.
243 karl  1.1.2.3     1. Extended ResponseTest MOF for for both CMPI and C++ subclasses
244                   2. Fixed issues with pullop.
245                   3. Fixed temp issue with CIMResponseData size by putting in mutex. That
246                      is not a permanent fix but it gets around issue probably in the control
247                      of the move logic that meant counts were off.
248                   4. Fixed issues in Dispatcher so that associator code works. Still messy
249                      code in the dispatcher.
250                   5. Changed name of Enumerationtable.h & cpp to EnumerationContextTable.*
251                   6  Changed name of ResponseStressTest module, classes, etc.
252                
253                TAG: TASK_PEP317_5JUNE_2013_2
254                
255 karl  1.1.2.2  2 June 2013
256 karl  1.1.2.1  
257                Issues  - KS
258                
259 karl  1.1.2.15  - Still way to many TODO and KS comments and KS_TEMPS.  Removing bit by bit.
260 karl  1.1.2.1  
261 karl  1.1.2.15  - Runtime variable connection for the config parameters not installed. That
262                   has been made into a separate bug (see bug 9819)
263 karl  1.1.2.1  
264                5. Issue with the threaded timer.  For some reason during tests it
265                eventually calls the timer thread with trash for the parm (which is
266                pointer to the EnumerationTable object). Caught because we do a valid
267                test at beginning of the function.
268                
269 karl  1.1.2.2  6. Still using the templates in CIMOperationRequestDispatcher to simplify
270                the handle... processing.  
271                
272                7. I think I have a way around the double move of objects in the
273                EnumerationContext so that the outputter will just take a defined number
274                of objects directly from the gathering cache and save the second move.
275                
276 karl  1.1.2.15 8. Not yet passing all tests but getting closer now. The major test that is
277                causing an error today is the execution of a full enumeration with the
278                forceProviders = true.  This causes a client timeout sometimes.
279 karl  1.1.2.2  
280                
281                
282 karl  1.1.2.1  ===========================================
283                
284                OVERVIEW:
285                
286                The operation extensions for pull operations defined in the DMTF specification
287                DSP0200 V 1.4 were implemented in Pegasus effective Pegasus version 2.11
288                including Client and Server.
289                
290                These operations extend the CIM/XML  individual operations to operation
291                sequences where the server must maintain state between operations in a
292                sequence and the client must execute multiple operations to get the full
293                set of instances or instance paths.
294                
295                The following new CIM/XML operations as defined in DSP0200 are included;
296                
297                    -OpenEnumerateInstances
298                    -openEnumerateInstancePaths
299                    -OpenReferenceInstances
300                    -OpenReferenceInstancePaths
301                    -OpenAssociatiorInstances
302                    -OpenAssociatorInstancePaths
303 karl  1.1.2.16     -OpenQueryInstances
304 karl  1.1.2.1      -PullInstancesWithPath
305                    -PullInstancePaths
306 karl  1.1.2.16     -PullInstances
307 karl  1.1.2.1      -CloseEnumeration
308                    -EnumerationCount
309 karl  1.1.2.2       OpenExecQuery
310 karl  1.1.2.1  
311                The following  operations have not been implemented in this version of Pegasus:
312                
313                    -OpenQueryInstances
314                
315                The following limitations on the implementation exist;
316                
317                1. The filterQueryLanguage and filterQuery parameters are processed by
318                   the Pegasus client but the server returns error if there is any data in
319 karl  1.1.2.2     either parameter. This work does not include the development of the
320                   query language.  Note that a separate effort to extend Pegasus to use
321                   the DMTF FQL query language is in process.
322 karl  1.1.2.1  
323                2. The input parameter continueOnError is processed correctly by the client
324                   but the Pegasus server only provides for false since the server does not
325                   include logic to continue processing responses after an error is
326                   encountered. 
327                   This is consistent with the statement in the specification that use of 
328                   this functionality is optional and the fact that the DMTF agrees that all 
329                   of the issues of continuing after errors have not been clarified.  
330                
331                3. The operation enumerationCount is not processed by the server today since
332                   a) really getting the count would be the same cost as the corresponding
333                   enumeration, b) the server does not include a history or estimating
334                   mechanism for this to date.
335 karl  1.1.2.2     NOTE: After a through review as part of the development of the next version
336                   of CMPI we have concluded that this operation is probably not worth the
337                   effort.  Since it is optional, Pegasus will only return the unknown status
338                   at this point
339 karl  1.1.2.1  
340                Since the concept of sequences of operations linked together (open, pull, close)
341                is a major extension to the original CIM/XML operation concept of completely
342                independent operations several new pieces of functionality are implemented
343                to control interOperationTimeouts, counts of objects to be returned, etc.
344                
345                TBD - Review this
346                
347                CLIENT
348                
349                The new operations follow the same pattern as the APIs for existing operations
350                in that:
351                
352                1. All errors are handled as CIMException and Exception
353                
354                2. The means of inputting parameters are the same except that there are
355                   significantly more input parameters with the open operations and for the 
356                   first time operations return parameters as well as objects in the 
357                   response.  Specifically the open and pull operations return values for 
358                   enumerationContext which is the identity for a pull sequence and 
359                   endOfSequence which is the marker the server sends in open and pull 
360 karl  1.1.2.1     responses when it has no more objects to send.
361                
362                The significant differences include:
363                
364                1. Processing of parameters on responses (i.e. the endOfSequence and
365                   enumerationContext parameters are returned for open and pull operations).
366                
367                2. Numeric arguments (Uint32 and Uint64 include the option of NULL in some
368                   cases so they are packaged inside classes Uint32Arg and Uint64Arg in the
369                   client api.
370                
371                3. The association and reference operations ONLY process instances.  They do
372                   not include the capability to return classes like reference and associator
373                   do and therefore return CIMInstance rather than CIMObject.
374                
375                4. Paths are returned in all cases (i.e OpenEnumerateInstances and
376                   PullInstancesWithPath where they were not with EnumeratInstances.
377                
378                5. The client must maintain state between operations in a sequence (using
379                   the enumerationContext parameter).
380                
381 karl  1.1.2.1  TBD- Are there more differences.
382                
383                
384                SERVER
385                
386                The Pegasus server attempts to always deliver the requested number of objects
387                for any open or pull request (the specification allows for the server to
388                deliver less than the requested number of objects and specifically to return
389                zero objects on open).  We felt that it was worth any extra cost in processing
390                to provide the client with exactly what it had requested.
391                
392                The pegasus server always closes an enumeration sequence upon receipt of any
393                error from the providers, repository, etc. Therefore the server will reject
394 karl  1.1.2.2  any request that has continueOnError = true;
395                
396                Expansion to allow the continue on error may be added in a future version.
397                In any case, the whole purpose of the continue on error is really to allow
398                input from good providers to be mixed with providers that return errors so
399                that generally this would mean simply changing the logic in the return mechanism 
400                to not shutdown when an error is received from any given provider.
401                
402                Generally we do not believe that the providers need to do much more in the
403                future to support the continueOnError other than possibly allowing the provider
404                to continue processing after it has received an error.
405 karl  1.1.2.1  
406                PROVIDERS
407                
408                This implementation requires NO changes to the existing providers.  The
409                provider APIs operate just as they do with the original operations.
410                
411                Because the server processing is different however, there may be some
412                behavior differences primarily because the client now controls the speed of
413                delivery of objects.
414                
415                In previous versions of Pegasus, the server attempts to deliver objects as
416                rapidly as then can be put on the network.  In the case of HTTP chunked requests
417                they are delivered in chunks of about 100 objects. The primary delay for the
418                providers was the processing of each segment through the server.  The server
419                is blocked so that no other segment can proceed through the server until that
420                segment is processed and sent on the network.
421                In the case of non-chunkedresponses, they are completely gathered in the serve
422                and then delivered as one non-chunked response. There were no delays for the
423                providers, just lots of possible memory use in the server.
424                
425                The responses from providers (delivered through the deliver(...) interface are
426 karl  1.1.2.1  gathered into segments of about 100 objects and this group of objects is moved
427                through the server to be delivered to the client.
428                
429                However with the inclusion of the pull operations,   The segments of objects
430                from the providers are cached in the server response path until the 
431                maxObjectCount for that request (open or pull) and that number returned in a
432                non-chunked response. Thus, if the client is slow to issue pull requests,
433                the providers might be delayed at some point to reduce memory usage in the
434                server (the delay appears as slow response tothe deliver operation).
435                
436                In other words, the time to process large sets of responses from the provider
437                now depends on the speed of handling the client.
438                
439                It is important to remember in developing providers that the Pegasus server
440                can most efficiently process responses if they are passed from the provider
441                to the server individually or in small arrays of objects rather than the
442                provider gathering very large arrays of objects and sending them to the
443                server.
444                
445 karl  1.1.2.2  NEXT GENERATION PROVIDERS
446                KS_TODO
447                
448 karl  1.1.2.1  CONFIGURATION PARAMETERS
449                
450                The server includes several configuration parameters to set limits on the
451                processing of pull operations.  All of these configuration parameters are
452                compile time parameters rather than runtime.
453                
454                1. Maximum value of minimum interoperation time.  This parameter defines the
455                maximum time allowed between the return of an open or pull response and 
456                the receipt of the next pull or a close operation before the server may 
457                close the enumeration.  The specification allows the server to set a 
458                maximum interoperation time and refuse open requests that with requested 
459                operationTimeout greater than that time.  
460                CIM_ERR_INVALID_OPERATION_TIMEOUT
461                
462                This value is set with the Pegasus environment variable
463                PEGASUS_PULL....
464                
465                2. Maximum objects returned in a single open or pull operation.  The server
466                can set a maximum limit on the number of objects that can be returned in
467                a single open or pull oepration with the maxObjectCount parameter.
468                
469 karl  1.1.2.1  3. Whether the server allows 0 as an interoperation timeout value. The value
470                zero is s special value for the interoperationTimeout in that it tells the
471                server to not timeout any enumeration sequence.
472                
473                With this value for interoperationTimeout, the only way to close an 
474                enumeration sequence is to complete all of the pulls or issue the close.  
475                If for some reason the sequence is not completed, that enumeration context 
476                would remain open indefinitly.  Since in Pegasus any open enumeration 
477                context uses resources (the context object and any provider resposnes that 
478                have not yet been issued in a response) it would appear that most 
479                platforms would not want to allow the existence of enumeration contexts 
480                that cannot be closed by the server.  
481                
482                4, maximum consecutive pull requests with 0 maxObjectCount.  The use of the
483                pull operation with maxObjectCount set to zero could be used to keep an
484                enumeration context open indefinitly (this tells the server to restart the
485                interoperationTimeout but not send any objects in the response). Therefore the
486                specification allows for the server setting maximum limits on this behavior
487                and returning the error CIM_ERR_SERVER_LIMITS_EXCEEDED if this limit is
488                exceeded.
489                Note that this is maximum CONSECUTIVE pulls so that issuing a pull with
490 karl  1.1.2.1  a non-zero count resets this counter.
491                
492                KS-TBD - Is this really logical since we can still block by just issuing
493                lots of zero request and an occansional request for one object.
494                
495                Pegaus sets the value of this limit to 1000 and allows the implementer to
496                modify it with the PEGASUS_MAXIMUM_ZERO_OBJECTCOUNT environment variable.
497                
498                5. Default operationTimeout - 
499                
500                The default of this parameter is to refuse operat
501                
502                In the current release of Pegasus these are all compile time parameters.
503 karl  1.1.2.11 
504                
505                NOTES On working with task branch.
506                
507                Merge out Process
508                
509                   To keep our TASK branch in sync with the current head of tree we need
510                   to do a regular merge out.  the TaskMakefile contains the makefile
511                   procedures to do this efficiently.  NOTE: Following these procedures is
512                   important in that you are merging out new material each time you do
513                   the merge out.  If you were just to repeatedly merge out, you would be
514                   merging previously merged changes a second time causing a real mess.
515                
516                    Start with new directory and put TaskMakefile above pegasus (needed so you
517                    have this file for the initial operations.  
518                
519                      make -f TaskMakefile branch_merge_out BNAME=PEP317-pullop  ## takes a long time
520                
521                   This checks out current head, merges it into task branch and sets tags
522                   for the mergeout.  Note that at the end of this step this work is
523                   part of the TASK... branch.
524 karl  1.1.2.11 
525                   NOW check for conflicts, errors, etc. that resulted from the merge.
526                   Look for conflict flags, compare the results (I use linux merge as a
527                   good graphic compare tool) and build and test. When you are satisfied
528                   that the merge out is clean, you can commit the results to the TASK...
529                   branch
530                   
531                   To commit the work to  this into Task branch
532                
533                      make -f mak/TaskMakefile branch_merge_out_commit BNAME=PEP317-pullop
534                
535                  or manually commit and finish as follows
536                
537                    cvs commit
538                    make -f mak/TaskMakefile  branch_merge_out_finish BNAME=PEP317-pullop
539                
540                ## This last step is important since it cleans up temporary tags to prepare
541                   you for the next checkout
542                   
543                COMPARE TASKBRANCH WITH HEAD
544                
545 karl  1.1.2.11     In a new pegasus work space do same as above for merge out.
546                
547                    make -f TaskMakefile BNAME=PEP317-pullop
548                
549                    This produces a result which is all of the head merged into the branch.
550                    A diff of this is all the new changes to the head of tree that you will
551                    include into the merge.
552                

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2