140d553cfSPaul BeesleyFrequently-Asked Questions (FAQ) 240d553cfSPaul Beesley================================ 340d553cfSPaul Beesley 440d553cfSPaul BeesleyHow do I update my changes? 540d553cfSPaul Beesley--------------------------- 640d553cfSPaul Beesley 740d553cfSPaul BeesleyOften it is necessary to update your patch set before it is merged. Refer to the 840d553cfSPaul Beesley`Gerrit Upload Patch Set documentation`_ on how to do so. 940d553cfSPaul Beesley 1040d553cfSPaul BeesleyIf you need to modify an existing patch set with multiple commits, refer to the 1140d553cfSPaul Beesley`Gerrit Replace Changes documentation`_. 1240d553cfSPaul Beesley 1340d553cfSPaul BeesleyHow long will my changes take to merge into ``integration``? 1440d553cfSPaul Beesley------------------------------------------------------------ 1540d553cfSPaul Beesley 1640d553cfSPaul BeesleyThis can vary a lot, depending on: 1740d553cfSPaul Beesley 1840d553cfSPaul Beesley* How important the patch set is considered by the TF maintainers. Where 1940d553cfSPaul Beesley possible, you should indicate the required timescales for merging the patch 2040d553cfSPaul Beesley set and the impact of any delay. Feel free to add a comment to your patch set 2140d553cfSPaul Beesley to get an estimate of when it will be merged. 2240d553cfSPaul Beesley 2340d553cfSPaul Beesley* The quality of the patch set. Patches are likely to be merged more quickly if 2440d553cfSPaul Beesley they follow the coding guidelines, have already had some code review, and have 2540d553cfSPaul Beesley been appropriately tested. 2640d553cfSPaul Beesley 2740d553cfSPaul Beesley* The impact of the patch set. For example, a patch that changes a key generic 2840d553cfSPaul Beesley API is likely to receive much greater scrutiny than a local change to a 2940d553cfSPaul Beesley specific platform port. 3040d553cfSPaul Beesley 3140d553cfSPaul Beesley* How much opportunity for external review is required. For example, the TF 3240d553cfSPaul Beesley maintainers may not wait for external review comments to merge trivial 3340d553cfSPaul Beesley bug-fixes but may wait up to a week to merge major changes, or ones requiring 3440d553cfSPaul Beesley feedback from specific parties. 3540d553cfSPaul Beesley 3640d553cfSPaul Beesley* How many other patch sets are waiting to be integrated and the risk of 3740d553cfSPaul Beesley conflict between the topics. 3840d553cfSPaul Beesley 3940d553cfSPaul Beesley* If there is a code freeze in place in preparation for the release. Please 4034760951SPaul Beesley refer the :ref:`Release Processes` document for more details. 4140d553cfSPaul Beesley 4240d553cfSPaul Beesley* The workload of the TF maintainers. 4340d553cfSPaul Beesley 4440d553cfSPaul BeesleyHow long will it take for my changes to go from ``integration`` to ``master``? 4540d553cfSPaul Beesley------------------------------------------------------------------------------ 4640d553cfSPaul Beesley 4740d553cfSPaul BeesleyThis depends on how many concurrent patches are being processed at the same 4840d553cfSPaul Beesleytime. In simple cases where all potential regressions have already been tested, 4940d553cfSPaul Beesleythe delay will be less than 1 day. If the TF maintainers are trying to merge 5040d553cfSPaul Beesleyseveral things over the course of a few days, it might take up to a week. 5140d553cfSPaul BeesleyTypically, it will be 1-2 days. 5240d553cfSPaul Beesley 5340d553cfSPaul BeesleyThe worst case is if the TF maintainers are trying to make a release while also 5440d553cfSPaul Beesleyreceiving patches that will not be merged into the release. In this case, the 5540d553cfSPaul Beesleypatches will be merged onto ``integration``, which will temporarily diverge from 5640d553cfSPaul Beesleythe release branch. The ``integration`` branch will be rebased onto ``master`` 5740d553cfSPaul Beesleyafter the release, and then ``master`` will be fast-forwarded to ``integration`` 5834760951SPaul Beesley1-2 days later. This whole process could take up 4 weeks. Please refer to the 5934760951SPaul Beesley:ref:`Release Processes` document for code freeze dates. The TF maintainers 6034760951SPaul Beesleywill inform the patch owner if this is going to happen. 6140d553cfSPaul Beesley 6240d553cfSPaul BeesleyIt is OK to create a patch based on commits that are only available in 6340d553cfSPaul Beesley``integration`` or another patch set, rather than ``master``. There is a risk 6440d553cfSPaul Beesleythat the dependency commits will change (for example due to patch set rework or 6540d553cfSPaul Beesleyintegration problems). If this happens, the dependent patch will need reworking. 6640d553cfSPaul Beesley 6740d553cfSPaul BeesleyWhat are these strange comments in my changes? 6840d553cfSPaul Beesley---------------------------------------------- 6940d553cfSPaul Beesley 7040d553cfSPaul BeesleyAll the comments from ``ci-bot-user`` are associated with Continuous Integration 7140d553cfSPaul Beesleyinfrastructure. The links published on the comment are not currently accessible, 7240d553cfSPaul Beesleybut would be after the CI has been transitioned to `trustedfirmware.org`_. 7340d553cfSPaul Beesley 7434760951SPaul Beesley-------------- 7534760951SPaul Beesley 76*3d28b0a4SSandrine Bailleux*Copyright (c) 2019-2020, Arm Limited. All rights reserved.* 7734760951SPaul Beesley 7840d553cfSPaul Beesley.. _Gerrit Upload Patch Set documentation: https://review.trustedfirmware.org/Documentation/intro-user.html#upload-patch-set 7940d553cfSPaul Beesley.. _Gerrit Replace Changes documentation: https://review.trustedfirmware.org/Documentation/user-upload.html#push_replace 8040d553cfSPaul Beesley.. _trustedfirmware.org: https://www.trustedfirmware.org/ 81