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