summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* quip-13: Add section about namespaced QtHEADmasterKai Köhne2024-04-171-1/+14
| | | | | | | | | | | | | Advise against using QT_BEGIN_NAMESPACE, QT_END_NAMESPACE, QT_FORWARD_DECLARE_CLASS macros. There might still be cases where it is needed - e.g. for overloading operators. But most cases can be easily avoided by just including Qt headers, uic generated headers already in the respective .h file. Change-Id: Ide4a2a93dee90a1adba70904838491240657f502 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: hjk <hjk@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Fix specified encoding for .rst filesKai Köhne2024-04-111-1/+1
| | | | | Change-Id: I854803f7a17972dad747121d22d4ff951461bcf9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Update QUIP 18Lucie Gérard2024-03-071-17/+44
| | | | | | Task-number: QTBUG-121039 Change-Id: I478c82ef6e63e33f99cdf164e412fca1bee1630a Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* flake8: fix a couple of detailsCristián Maureira-Fredes2024-01-081-1/+3
| | | | | Change-Id: I4ea1d2063a666803cfb6f43a4e68a24b7d7f9e2c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* remove glob because it's not usedCristián Maureira-Fredes2024-01-081-1/+0
| | | | | Change-Id: I6c3606df8d977e2c0d908f6bfc1ee42b46befea3 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Update QUIP 21Leena Miettinen2023-12-191-38/+36
| | | | | | | | | | An earlier patch got accidentally pushed, approved and published. Fixed the Post-History value, links to references, and the level of the References heading. Change-Id: Ib47d5c6f566b1ee4e5425776fe50ad466614fc95 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add QUIP-21: Using images in Qt documentationLeena Miettinen2023-12-181-0/+167
| | | | | | | | Add a QUIP that contains guidelines for using images in Qt documentation. Change-Id: Ibfe53a6a76c11b8d49a69e70aedc5ecef2a07724 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Update the accepted format for copyrightLucie Gérard2023-12-141-1/+2
| | | | | | Task-number: QTBUG-111873 Change-Id: Id5bc5f287536afa969b0b4dfc82e9ceefb8531e4 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* [non-normative] QUIP-6: fix issue with a non-target using underscoreCristián Maureira-Fredes2023-08-311-1/+1
| | | | | | | | | | | | | Using the notation: "_sometext_" doesn't work to empathize in rst, and the generator will understand "sometext_" as a target, which is not declared, so it generates an error. In this specific case: _opt-in_, the target "in_" was not declared, so QUIP-6 was not generated at all. Change-Id: I842760f0c5ada3a708ac4fc546364569b313e6a1 Reviewed-by: Marc Mutz <marc.mutz@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* fix format issues with quip 0019Cristián Maureira-Fredes2023-07-051-5/+5
| | | | | | | | | | | | Titles should have a underlying character the same length as the title. References, when not properly cited in the text, should be plain hyperlinks, otherwise the leading ".." will make them a comment. Change-Id: I403b6e6746c92127d73c0c60d48f38ad148dceec Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* [normative] Update QUIP-0019 for C++20 [[nodiscard("reason")]]Marc Mutz2023-06-301-11/+12
| | | | | | | Fixes: QTBUG-114767 Change-Id: I8f6340d2baa665c7b9767889ff5d1d798a0fe6de Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* [normative] QUIP-0019: require named ctors to be [[nodiscard]] if ctors ↵Marc Mutz2023-06-301-0/+5
| | | | | | | | | | | should be There is no reason to distinguish normal from named ctors. Task-number: QTBUG-104164 Change-Id: I8ed01eab0b4343dae0ffaa956f46e2bf88bb26d1 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* [normative] QUIP-0019: [[nodiscard]] PolicyMarc Mutz2023-06-301-0/+155
| | | | | | | | Fixes: QTBUG-104167 Change-Id: I4b6b079f4a1c0ee39035aa424f9447732424975c Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io> Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* [normative] QUIP-6: mention SiC B's can be acceptable if opt-inMarc Mutz2023-06-291-0/+3
| | | | | | | | Give examples. Change-Id: I3391cd265378b42854ac7feb76d087916d92acfa Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Update Chief Maintainer voting processVolker Hilsheimer2023-06-261-3/+16
| | | | | | | | | | | | | | | | | | Document process based on the mailing list discussion at https://lists.qt-project.org/pipermail/development/2022-May/042478.html and the defacto process used to vote a new Chief Maintainer in June 2022, when we had two nominees. This change deliberately does not provided guidance for the case of more than two nominated candidates, leaving it to the then-active Maintainers to decide. Deciding and documenting the voting process for such a scenario is subject of a dedicated QUIP. Change-Id: I64ec5f1a6a22b7ddd563e1dafcdede8ddc81ead1 Reviewed-by: Lars Knoll <lars@knoll.priv.no> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Robert Löhning <robert.loehning@qt.io> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* QUIP 7: Add optional 'SecurityCritical' attributeKai Köhne2023-03-311-1/+7
| | | | | | | | | This is only informative / for the author (or release manager) for now and is not shown in the documentation. Change-Id: I5a7f8244189606654cabfc3ace530d1b988b4a00 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Tuukka Turunen <tuukka.turunen@qt.io>
* QUIP 18: License specification in Qt's modulesJoerg Bornemann2023-03-281-0/+167
| | | | | | | | | | | This QUIP specifies the licenses that are used in different parts of a typical Qt module repository. Note that repositories may deviate from this guideline. Check with the authors and copyright holders of the repository in question. Task-number: QTBUG-104704 Change-Id: I1487cd3a16be4a6dc4e36252a17ce894c09676a2 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Provide for Comment fields in attribution filesEdward Welbourne2023-03-031-1/+8
| | | | | | | | | | | The lack of a comment format in JSON makes it tiresome for developers to leave notes for the benefit of those who may update a third-party component in future. So provide Comment fields for notes on any supported field. Change-Id: I97b00010e267537c0e4ffa6cf7a1ce4089a4b63c Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Add simple template optionCristián Maureira-Fredes2023-02-134-3/+52
| | | | | | | | | | | | | | This includes a new minimal HTML template to be used to render the QUIPs, motivated by the inclusion of the generated HTML files into the qt-project.org website. A new make variable is used QUIP_TEMPLATE, so one can select a different HTML base file, skipping the current default approach of patching the PlanetQt theme. Change-Id: Iefbc7024d2fccc66241d541c53e46a9b4fdf9cff Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* fix utf-8 typo and stdout.reconfigure callCristián Maureira-Fredes2023-02-061-1/+1
| | | | | Change-Id: I913df84cf30ed8a3c421864c0ef60bd01dc52255 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Remove broken twitter URL from the templateEdward Welbourne2023-01-261-5/+8
| | | | | Change-Id: I2153c3124cf27fdd2a4e641302e5c8b59df2a1c8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* [normative] QUIP-6: add <QStyleHeader> exception to B.7Marc Mutz2023-01-231-1/+5
| | | | | | | | | | | | It's SiC A if only the target of the forwarding header changes, but not user source code. We did that for QVariantMap/QVariantHash in Qt 6.4. Change-Id: I7f454305382ebdc6634140e1cb83cfe9cf144382 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* [normative] QUIP-6: mention that moving stuff between headers is SiC BMarc Mutz2023-01-211-0/+7
| | | | | | | | | | Even though it's technically SiC A, at least if the target header already existed in the SC epoch, we decided that we don't want to bother our users with these when we hit this issue with qVersion() being moved from qglobal.h into a header not included from qglobal.h. Change-Id: I792dca18584cb5f7f49938fd20f71831a9e6754c Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* QUIP 6: Add the intent to not break SC without good enough reasonhjk2023-01-191-2/+9
| | | | | | | | | The governing idea is that source compatibility breakages are a nuisance to Qt users, so breaking it should be the exception, not the norm, and only done if they provide a good trade-off. Change-Id: I99f2d6151d64467eb6ffc515428f77f9371f7179 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* QUIP-15: Remove mentioning of 'Core Security Team' gerrit groupKai Köhne2023-01-161-3/+4
| | | | | | | | | The group does not exist. Instead, membership is defined by being subscribed to the security@qt-project.org mailing list (which is not publicly visible, but well). Change-Id: I2e33e7e32a5ff50740d058703e3edd33b3fe7ba9 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix QUIP-0000 generator scriptJoerg Bornemann2023-01-101-1/+2
| | | | | | | | - stdout needs to be imported from sys - fix 'tf-8' encoding typo Change-Id: I3765e2089ab811f79744f9c4e912fac483515221 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Mention reuse tool in QUIP-7Kai Köhne2023-01-071-1/+8
| | | | | | | | Remove mentioning of Qt 5.8 as a drive-by, as this is only of historic interest. Change-Id: I1a7d1064917ae06b9cd2765c13ddb9100b911b1b Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* [editorial] QUIP-6: number the rows in the tableMarc Mutz2022-12-201-23/+23
| | | | | | | | | | This allows easier reference from reviews: "eh, that's SiC type B.1", "no, it's A.1, because we QT_REMOVED_SINCE the old overload". Change-Id: Ie23357e18d76900c1ba1631861780bccf9035bae Reviewed-by: hjk <hjk@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix encoding problems on WindowsKai Köhne2022-12-202-2/+6
| | | | | | | Enforce all input/output to be in UTF-8. Change-Id: I5e908ff5ec95e05d9cc95d2fbd92b88040bed4b1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* QUIP 7: Document the 'Files' propertyJoerg Bornemann2022-12-141-2/+4
| | | | | Change-Id: Iac1c08d750446a39ec5bc4734d94f22ffc0029fe Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* QUIP 7: Clarify how license files are specifiedJoerg Bornemann2022-11-301-1/+27
| | | | | | | | Add the missing LicenseFiles property, and explain the "SPDX mode" of specifying license files. Change-Id: I909b6efe4ef5d5ecf2c2c11b9018555269bcf060 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Fix Makefile rule for patch to succeed on diff status 1Edward Welbourne2022-10-211-1/+2
| | | | | | | | | The exit status for diff is "0 if inputs are the same, 1 if different, 2 if trouble." So say out loud that the patch is empty if diff "succeeds", otherwise succeed precisely if its status was 1. Change-Id: Ia2497a0c9673e0c663d01d6e34815e663b83ba09 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Remove broken link to dead cloudfront resource from template.htmlEdward Welbourne2022-10-211-6/+8
| | | | | | | | | The cloudfront URL is on a non-existent host, so does not work; better to not link to it, in case that DNS entry ever resurfaces with some content on it that we'd rather not include in our pages. Change-Id: I029d5ce7324fa43bdbe9d5abc6a39f84349adb3f Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Change feed-back mail subject to be QUIP-specificEdward Welbourne2022-10-201-1/+1
| | | | | | | | | | Since the QUIPs are apt to be published on qt-project.org in any case, make sure that the feedback is clear that it's about QUIPs, at least, so that the good folk at feedback@ have a clue how to reroute any feedback they get from this link. Change-Id: I3a0ae35fd9ff2e848da02fa9c912f2e7cee37ea4 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Adapt each QUIP's self-link to use the right URLEdward Welbourne2022-10-132-6/+8
| | | | | | | | | | | | | Originally QUIPs were to be simply numbered. At some point we realized we could include some mention of the subject matter in the rst-file name. However, the quip2html script was still assuming quip-0012.html (for example) would be the URL of QUIP 12, without its subject matter suffix. Amend the script, and the template's token used to build the URL, to include the full filename stem (without .rst suffix) in the URL (with a .html suffix). Change-Id: I04d09c3ae80620d13f62a2f8cd2b3dcce3d159b8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Introduce QUIP 13, "Qt Examples"Kai Koehne2022-10-131-0/+134
| | | | | | | | | | | | | | | The aim of this QUIP is twofold: Consolidate best practices currently encoded in the examples, and explained in the wiki pages https://wiki.qt.io/Writing_Qt_Examples and https://wiki.qt.io/Documentation_Style_for_Examples. Be able to reach a consensus about new requirements. Change-Id: I9cec1882dc43dde56c8fb96bbbd745061accfeb1 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Add a style-hack to work around PlanetQt's broken en and strongEdward Welbourne2022-10-071-6/+12
| | | | | | | | | Until PlanetQt merges my proposed fix, or comes up with a better one, we can kludge it in via the template diff for QUIPs. Task-number: QTWEBSITE-1071 Change-Id: I74a59ad4f6d029fb7f4e506f28e4d99f9f9ca3e7 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Add a make rule to regenerate the template diffEdward Welbourne2022-10-072-9/+23
| | | | | Change-Id: I17d27f5daadc2e9730270e3488ce7f6f3d215716 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Declare more make targets phonyEdward Welbourne2022-10-071-1/+3
| | | | | | | I forgot to do this when creating the Makefile. Change-Id: I13437bc54905c13cf189f7e43a659c5cec8c7326 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Provide an easier process for replacing inactive maintainerVolker Hilsheimer2022-09-141-1/+16
| | | | | | | | | | | | | | | | | | | | | | | We need a lower-threshold process to replace maintainers that are inactive and not reachable. This is based on the proposal made at the Qt Contributors Summit 2022: https://wiki.qt.io/Qt_Contributors_Summit_2022_-_Program/Ghost_Maintainers Making it possible to retire and/or replace inactive maintainers require that we define some criteria for "inactivity". List approval of API/header reviews explicitly as a maintainer's responsibility. It is a very observable activity, and critical to the release process. Maintainers that are not following up on that responsibility, and in addition do not respond to emails in which at least one other Maintainer is copied, can be considered inactive. In that situation, a new Maintainer may be nominated, following the regular process, which still allows the old Maintainer to object. Change-Id: I944515f8acb449ef916612f4f3e457726a7f612b Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Update Planet Qt submodule to latest versionEdward Welbourne2022-09-142-15/+14
| | | | | | | | | As at planetqt commit 3e350aefca147b9c06361a25947fe5cd931da0c9 (last template.qt update 2019) and update scripts/template.diff to match. Change-Id: I6c03176e31e175d627d7446cafda53013858a9ac Reviewed-by: Olli Puurunen <olli.puurunen@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Fix an out-of-date URL in QUIP 0Edward Welbourne2022-09-141-1/+1
| | | | | Change-Id: I6d3e37c250f2a2d222e35d142491bf76899db0d3 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Remove the qmake config now that we no longer need itEdward Welbourne2022-09-142-59/+0
| | | | | | | | | At least on Unix, with GNU make installed, we can just use the Makefile. This makes quips.pro and scripts/setup.mk redundant. Task-number: QTWEBSITE-1041 Change-Id: I2c6f5126e5ad6f393f22af893cba692cb2207eed Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Add a Makefile to make qmake's .pro redundantEdward Welbourne2022-09-143-47/+113
| | | | | | | | | | | This does the job and even lets you configure the output HTML directory for yourself. Update the ReadMe and .gitignore to take account of the new way to build. Correct various details in it along the way. Fixes: QTWEBSITE-1041 Change-Id: I8012894b2a73fc76e9ba15d4cca4627cff4e73ce Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Reconcile QUIP-0017 and QUIP-0006Marc Mutz2021-07-152-5/+4
| | | | | | | | | | | | | Have QUIP-0006 mention that the module should be in the [ChangeLog] line. Have QUIP-0017 mention QUIP-0006's [Potentially Source-Incompatible Changes] tag as common. Change-Id: I50c141eda7fb262e4f8333069d88c2db61a44711 Reviewed-by: Andreas Buhr <andreas.buhr@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Quip 2: Fix URLRobert Löhning2021-06-091-1/+1
| | | | | Change-Id: I5418b8fc64136e073a1846ba4ad26d2eed9bd201 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Upgrade quip-generation scripts to use python3Edward Welbourne2021-06-073-8/+7
| | | | | | | | | | | | | | Scripts use docutils; Debian/testing has dropped python2 support for docutils, forcing the upgrade. Ran 2to3 and did as it told me. One print needed parentheses. Changed #! lines and quips.pro to use python3 explicitly. The docutils.core.publish_string() call was returning a bytes object, where output.write() needed a string; so set output encoding. Change-Id: I910548c7402b4bb8a22559793278dc9b5461b94d Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a quip for change log creationMitch Curtis2020-09-031-0/+79
| | | | | | | | | Mostly important for settling on which content should and should not be included in change logs, but also documents which tool is preferred. Change-Id: I9673027db7b4ddea2e41eacfaddd9f754323e7b1 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* The API change review scripts have moved to qtqaEdward Welbourne2020-09-021-3/+3
| | | | | Change-Id: I44de473ce8f204b8627d6a8cc6c96de583c2c424 Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* QUIP 0: Add a tail-piece about our update processEdward Welbourne2020-07-091-1/+13
| | | | | | | | | The front page should say where (and what) the authoritative sources are and how to contribute changes. Change-Id: I98e17f7391531fcb214cb641bdef7cf16b7e2188 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-10 16:38:03 +0000