1*54fd6939SJiyong ParkFrequently-Asked Questions (FAQ) 2*54fd6939SJiyong Park================================ 3*54fd6939SJiyong Park 4*54fd6939SJiyong ParkHow do I update my changes? 5*54fd6939SJiyong Park--------------------------- 6*54fd6939SJiyong Park 7*54fd6939SJiyong ParkOften it is necessary to update your patch set before it is merged. Refer to the 8*54fd6939SJiyong Park`Gerrit Upload Patch Set documentation`_ on how to do so. 9*54fd6939SJiyong Park 10*54fd6939SJiyong ParkIf you need to modify an existing patch set with multiple commits, refer to the 11*54fd6939SJiyong Park`Gerrit Replace Changes documentation`_. 12*54fd6939SJiyong Park 13*54fd6939SJiyong ParkHow long will my changes take to merge into ``integration``? 14*54fd6939SJiyong Park------------------------------------------------------------ 15*54fd6939SJiyong Park 16*54fd6939SJiyong ParkThis can vary a lot, depending on: 17*54fd6939SJiyong Park 18*54fd6939SJiyong Park* How important the patch set is considered by the TF maintainers. Where 19*54fd6939SJiyong Park possible, you should indicate the required timescales for merging the patch 20*54fd6939SJiyong Park set and the impact of any delay. Feel free to add a comment to your patch set 21*54fd6939SJiyong Park to get an estimate of when it will be merged. 22*54fd6939SJiyong Park 23*54fd6939SJiyong Park* The quality of the patch set. Patches are likely to be merged more quickly if 24*54fd6939SJiyong Park they follow the coding guidelines, have already had some code review, and have 25*54fd6939SJiyong Park been appropriately tested. 26*54fd6939SJiyong Park 27*54fd6939SJiyong Park* The impact of the patch set. For example, a patch that changes a key generic 28*54fd6939SJiyong Park API is likely to receive much greater scrutiny than a local change to a 29*54fd6939SJiyong Park specific platform port. 30*54fd6939SJiyong Park 31*54fd6939SJiyong Park* How much opportunity for external review is required. For example, the TF 32*54fd6939SJiyong Park maintainers may not wait for external review comments to merge trivial 33*54fd6939SJiyong Park bug-fixes but may wait up to a week to merge major changes, or ones requiring 34*54fd6939SJiyong Park feedback from specific parties. 35*54fd6939SJiyong Park 36*54fd6939SJiyong Park* How many other patch sets are waiting to be integrated and the risk of 37*54fd6939SJiyong Park conflict between the topics. 38*54fd6939SJiyong Park 39*54fd6939SJiyong Park* If there is a code freeze in place in preparation for the release. Please 40*54fd6939SJiyong Park refer the :ref:`Release Processes` document for more details. 41*54fd6939SJiyong Park 42*54fd6939SJiyong Park* The workload of the TF maintainers. 43*54fd6939SJiyong Park 44*54fd6939SJiyong ParkHow long will it take for my changes to go from ``integration`` to ``master``? 45*54fd6939SJiyong Park------------------------------------------------------------------------------ 46*54fd6939SJiyong Park 47*54fd6939SJiyong ParkThis depends on how many concurrent patches are being processed at the same 48*54fd6939SJiyong Parktime. In simple cases where all potential regressions have already been tested, 49*54fd6939SJiyong Parkthe delay will be less than 1 day. If the TF maintainers are trying to merge 50*54fd6939SJiyong Parkseveral things over the course of a few days, it might take up to a week. 51*54fd6939SJiyong ParkTypically, it will be 1-2 days. 52*54fd6939SJiyong Park 53*54fd6939SJiyong ParkThe worst case is if the TF maintainers are trying to make a release while also 54*54fd6939SJiyong Parkreceiving patches that will not be merged into the release. In this case, the 55*54fd6939SJiyong Parkpatches will be merged onto ``integration``, which will temporarily diverge from 56*54fd6939SJiyong Parkthe release branch. The ``integration`` branch will be rebased onto ``master`` 57*54fd6939SJiyong Parkafter the release, and then ``master`` will be fast-forwarded to ``integration`` 58*54fd6939SJiyong Park1-2 days later. This whole process could take up 4 weeks. Please refer to the 59*54fd6939SJiyong Park:ref:`Release Processes` document for code freeze dates. The TF maintainers 60*54fd6939SJiyong Parkwill inform the patch owner if this is going to happen. 61*54fd6939SJiyong Park 62*54fd6939SJiyong ParkIt is OK to create a patch based on commits that are only available in 63*54fd6939SJiyong Park``integration`` or another patch set, rather than ``master``. There is a risk 64*54fd6939SJiyong Parkthat the dependency commits will change (for example due to patch set rework or 65*54fd6939SJiyong Parkintegration problems). If this happens, the dependent patch will need reworking. 66*54fd6939SJiyong Park 67*54fd6939SJiyong ParkWhat are these strange comments in my changes? 68*54fd6939SJiyong Park---------------------------------------------- 69*54fd6939SJiyong Park 70*54fd6939SJiyong ParkAll the comments from ``ci-bot-user`` are associated with Continuous Integration 71*54fd6939SJiyong Parkinfrastructure. The links published on the comment are not currently accessible, 72*54fd6939SJiyong Parkbut would be after the CI has been transitioned to `trustedfirmware.org`_. 73*54fd6939SJiyong Park 74*54fd6939SJiyong Park-------------- 75*54fd6939SJiyong Park 76*54fd6939SJiyong Park*Copyright (c) 2019-2020, Arm Limited. All rights reserved.* 77*54fd6939SJiyong Park 78*54fd6939SJiyong Park.. _Gerrit Upload Patch Set documentation: https://review.trustedfirmware.org/Documentation/intro-user.html#upload-patch-set 79*54fd6939SJiyong Park.. _Gerrit Replace Changes documentation: https://review.trustedfirmware.org/Documentation/user-upload.html#push_replace 80*54fd6939SJiyong Park.. _trustedfirmware.org: https://www.trustedfirmware.org/ 81