[sdk/kdesrc-build] /: Remove unused opts from doc
Nate Graham
null at kde.org
Fri Nov 17 16:18:04 GMT 2023
Git commit 176f459a855b74773bbbb0163813ed05e0a4e6f9 by Nate Graham, on behalf of Andrew Shark.
Committed on 17/11/2023 at 17:18.
Pushed by ngraham into branch 'master'.
Remove unused opts from doc
M +2 -3 doc/README.md
M +0 -121 doc/index.docbook
M +1 -12 modules/ksb/BuildContext.pm
M +0 -23 modules/ksb/Module.pm
M +0 -2 modules/ksb/ModuleSet/KDEProjects.pm
M +2 -11 modules/ksb/Updater/Git.pm
M +1 -1 vim/syntax/kdesrc-buildrc.vim
https://invent.kde.org/sdk/kdesrc-build/-/commit/176f459a855b74773bbbb0163813ed05e0a4e6f9
diff --git a/doc/README.md b/doc/README.md
index e81aef8b..ff2a487b 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -135,9 +135,8 @@ but for now they're at least worth nothing here:
- Use the `ignore-modules` option with your module sets if you want to build
every module in the set *except* for a few specific ones.
-- Annoyed by the default directory layout? Consider the `ignore-kde-structure`
- configuration file option to get the every-module-in-a-single-directory
- behavior many find more appealing.
+- Annoyed by the default directory layout? Consider changing the `directory-layout`
+ configuration file option.
- kdesrc-build supports building from behind a proxy, for all you corporate
types trying to get the latest-and-greatest desktop. Just make sure your
diff --git a/doc/index.docbook b/doc/index.docbook
index d39ec95c..fd83f081 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -44,8 +44,6 @@
<!ENTITY module-base-path '<link linkend="conf-module-base-path">module-base-path</link>'>
<!ENTITY override-url '<link linkend="conf-override-url">override-url</link>'>
<!ENTITY source-dir '<link linkend="conf-source-dir">source-dir</link>'>
- <!ENTITY email-address '<link linkend="conf-email-address">email-address</link>'>
- <!ENTITY email-on-compile-error '<link linkend="conf-email-on-compile-error">email-on-compile-error</link>'>
<!ENTITY colorful-output '<link linkend="conf-colorful-output">colorful-output</link>'>
<!ENTITY tag '<link linkend="conf-tag">tag</link>'>
<!ENTITY branch '<link linkend="conf-branch">branch</link>'>
@@ -1776,27 +1774,6 @@ option.</para></listitem>
<tbody>
-<row>
-<entry>apidox</entry>
-<entry></entry>
-<entry><para>This option was used to allow for building KDE module API documentation.
-It was removed in &kdesrc-build; 1.6.3 due to lack of support. Online
-API documentation is available from <ulink url="https://api.kde.org/">kde.org</ulink>.
-In addition it is possible to build KDE API documentation using the
-<command>kdedoxygen.sh</command> script included in the kde-dev-scripts module.
-See <ulink url="https://techbase.kde.org/Development/Tools/apidox">KDE
-TechBase</ulink> for more details.</para>
-</entry>
-</row>
-
-<row>
-<entry>apply-qt-patches</entry>
-<entry></entry>
-<entry>This option was removed in kdesrc-build 1.10. To get the same effect,
-see <xref linkend="using-qt" /> and the <link
-linkend="conf-repository">repository</link> option.</entry>
-</row>
-
<row id="conf-async">
<entry>async</entry>
<entry>Cannot be overridden</entry>
@@ -1864,23 +1841,6 @@ option.
normal development track without having to pay attention to all the branch name
changes.</para>
-<para>The current branch groups (as of 2013-08-11) are:</para>
-
-<itemizedlist>
-
-<listitem><para><literal>stable-qt4</literal>, for tracking bugfixes to the
-&Qt; 4-based &kde; libraries and applications.</para></listitem>
-
-<listitem><para><literal>latest-qt4</literal>, for tracking development and new
-features for the &Qt; 4-based &kde; libraries and
-applications.</para></listitem>
-
-<listitem><para><literal>kf5-qt5</literal>, for tracking
-<quote>bleeding-edge</quote> development for the upcoming &Qt; 5-based &kde;
-Frameworks 5, &plasma; Workspace 2, &etc;</para></listitem>
-
-</itemizedlist>
-
<para>Note that if you <emphasis>do</emphasis> choose a
<literal>branch</literal> yourself, that it will override this setting. The
same is true of other specific branch selection options such as <link
@@ -2152,32 +2112,6 @@ options.</para>
</entry>
</row>
-<row id="conf-email-address">
-<entry>email-address</entry>
-<entry>Cannot be overridden</entry>
-<entry>
-<para>This option was removed in &kdesrc-build; 1.14.
-</para>
-</entry>
-</row>
-
-<row id="conf-email-on-compile-error">
-<entry>email-on-compile-error</entry>
-<entry>Cannot be overridden</entry>
-<entry>
-<para>This option was removed in &kdesrc-build; 1.14.
-</para>
-</entry>
-</row>
-
-<row>
-<entry>inst-apps</entry>
-<entry></entry>
-<entry>
-This option was removed in version 1.10
-</entry>
-</row>
-
<row id="conf-git-desired-protocol">
<entry>git-desired-protocol</entry>
<entry>Cannot be overridden</entry>
@@ -2318,17 +2252,6 @@ on also use that proxy server, if possible, by setting the
</entry>
</row>
-<row id="conf-ignore-kde-structure">
-<entry>ignore-kde-structure</entry>
-<entry>Module setting overrides global</entry>
-<entry>
-<para>This option is deprecated and will be removed (again) in a future release.</para>
-
-<para>Please use <option><link linkend="conf-directory-layout">directory-layout</link></option>
-instead, which offers more options.</para>
-</entry>
-</row>
-
<row id="conf-directory-layout">
<entry>directory-layout</entry>
<entry>Module setting overrides global</entry>
@@ -2633,13 +2556,6 @@ source code for the module automatically. It will still try to build the
module if it normally would have tried anyways.</entry>
</row>
-<row>
-<entry>no-rebuild-on-fail</entry>
-<entry></entry>
-<entry>This option was removed in version 1.10, since this behavior no longer helps
-due to fixes in the underlying build system.</entry>
-</row>
-
<row id="conf-num-cores">
<entry>num-cores</entry>
<entry>Cannot be overridden</entry>
@@ -2938,14 +2854,6 @@ until &kdesrc-build; 1.16.</para>
</entry>
</row>
-<row>
-<entry>use-cmake</entry>
-<entry></entry>
-<entry>This option was removed in &kdesrc-build; 1.4 as all &kde; 4 modules
-require &cmake;, and &cmake; use is not permitted on any other modules.
-</entry>
-</row>
-
<row id="conf-use-idle-io-priority">
<entry>use-idle-io-priority</entry>
<entry>Cannot be overridden</entry>
@@ -3003,25 +2911,6 @@ of its use and an example.</para>
</entry>
</row>
-<row id="conf-use-qt-builddir-hack">
-<entry>use-qt-builddir-hack</entry>
-<entry>Module setting overrides global</entry>
-<entry>This option has been removed due to improvements in the &Qt; build
-system.
-</entry>
-</row>
-
-<row id="conf-use-stable-kde">
-<entry>use-stable-kde</entry>
-<entry>Can't be overridden</entry>
-<entry>
-<para>This option is deprecated and will be removed (again) in a future release.</para>
-
-<para>Please use the <option><link linkend="conf-branch-group">branch-group</link></option>
-instead, which offers more selectivity.</para>
-</entry>
-</row>
-
</tbody>
</tgroup>
@@ -3489,16 +3378,6 @@ kdepim: master
</listitem>
</varlistentry>
-<varlistentry id="cmdline-no-rebuild-on-fail">
-<term><parameter>--no-rebuild-on-fail</parameter></term>
-<listitem><para>
-Do not try to
-rebuild modules that have failed building from scratch. &kdesrc-build; will
-never try to do this to a module that already was tried to be built from
-scratch.
-</para></listitem>
-</varlistentry>
-
<varlistentry id="cmdline-refresh-build">
<term><parameter>--refresh-build</parameter> (or <parameter>-r</parameter>)</term>
<listitem><para>
diff --git a/modules/ksb/BuildContext.pm b/modules/ksb/BuildContext.pm
index d2a0cc6e..831c66f3 100644
--- a/modules/ksb/BuildContext.pm
+++ b/modules/ksb/BuildContext.pm
@@ -131,7 +131,6 @@ our %defaultGlobalFlags = (
"disable-snapshots" => 1, # 2016-07-31 Temp. disabled until kde.org fixed to supply snapshots
"compile-commands-export" => 1, # 2021-02-06 allow to generate compile_commands.json via cmake, for clangd tooling
"compile-commands-linking" => 0, # 2021-02-06 link generated compile_commands.json back to the source directory
- "ignore-kde-structure" => 0, # Whether to use kde dir structure like extragear/network. Deprecated as of late December 2020/January 2021
"include-dependencies" => 0, # 2019-08-31 Made negatable from cmdline (NB: false here but true in rcfile)
"install-after-build" => 1,
"install-environment-driver" => 1, # Setup ~/.config/kde-env-*.sh for login scripts
@@ -141,7 +140,6 @@ our %defaultGlobalFlags = (
"stop-on-failure" => 1,
"use-clean-install" => 0,
"use-idle-io-priority" => 0,
- "use-stable-kde" => 0,
"use-inactive-modules" => 0,
);
@@ -1058,16 +1056,7 @@ sub getProjectDataReader
sub effectiveBranchGroup
{
my $self = shift;
- my $branchGroup = $self->getOption('branch-group') // '';
-
- if (!$branchGroup) {
- $branchGroup = $self->getOption('use-stable-kde')
- ? 'latest-qt4'
- : ($self->hasOption('use-stable-kde') # Could also be false if unset
- ? 'kf5-qt5' # Really set to false
- : 'latest-qt4'); # Unset / this is default branch group if no option set
- }
-
+ my $branchGroup = $self->getOption('branch-group') // 'kf5-qt5';
return $branchGroup;
}
diff --git a/modules/ksb/Module.pm b/modules/ksb/Module.pm
index e186666e..157c88cb 100644
--- a/modules/ksb/Module.pm
+++ b/modules/ksb/Module.pm
@@ -998,29 +998,6 @@ sub destDir ($self)
my $basePath;
my $layout = $self->getOption('directory-layout');
- my $oldlayout = $self->getOption('ignore-kde-structure');
- if ($oldlayout) {
- # avoid spamming
- if (!$self->hasOption('#warned-deprecated-ignore-kde-structure')) {
- if($oldlayout eq 'true' || $oldlayout == 1) {
- warning("The option b[ignore-kde-structure true] is deprecated. Please replace it with b[directory-layout flat] in your configuration file.");
- } else {
- warning("The option b[ignore-kde-structure false] is deprecated. Please replace it with b[directory-layout invent] in your configuration file.");
- }
- }
- # no or equivalent layout configured, assume the user wants to use flat layout
- if (!$layout || $layout eq 'flat') {
- $layout = 'flat';
- } else {
- # avoid spamming
- if (!$self->hasOption('#warned-deprecated-ignore-kde-structure')) {
- warning("Deprecated b[ignore-kde-structure] will be ignored in favour of b[directory-layout] for b[$self]");
- }
- }
-
- $self->setOption('#warned-deprecated-ignore-kde-structure', 1);
- }
-
if ($layout eq 'flat') {
$basePath = $self->name();
} else {
diff --git a/modules/ksb/ModuleSet/KDEProjects.pm b/modules/ksb/ModuleSet/KDEProjects.pm
index 319c072f..5d9d5e61 100644
--- a/modules/ksb/ModuleSet/KDEProjects.pm
+++ b/modules/ksb/ModuleSet/KDEProjects.pm
@@ -45,7 +45,6 @@ sub _createMetadataModule
# Hardcode the results instead of expanding out the project info
$metadataModule->setOption('repository', "kde:$moduleName");
$metadataModule->setOption('#kde-project-path', $moduleName);
- $metadataModule->setOption('#branch:stable', 'master');
$metadataModule->setScmType('metadata');
$metadataModule->setOption('disable-snapshots', 1);
$metadataModule->setOption('branch', 'master');
@@ -143,7 +142,6 @@ sub _expandModuleCandidates ($self, $ctx, $moduleSearchItem)
$newModule->setOption('repository', $result->{repo});
$newModule->setOption('#kde-project-path', $result->{fullName});
$newModule->setOption('#kde-repo-path', $result->{inventName});
- $newModule->setOption('#branch:stable', undef);
$newModule->setOption('#found-by', $result->{found_by});
# Temp flag during metadata transition
$newModule->setOption('#upcoming-name-change', $result->{nameChangingTo})
diff --git a/modules/ksb/Updater/Git.pm b/modules/ksb/Updater/Git.pm
index 8ecfe7c1..99b8679a 100644
--- a/modules/ksb/Updater/Git.pm
+++ b/modules/ksb/Updater/Git.pm
@@ -608,19 +608,17 @@ sub _determinePreferredCheckoutSource
[qw(tag tag module)],
[qw(branch branch module)],
[qw(branch-group branch module)],
- [qw(use-stable-kde branch module)],
# commit/rev/tag don't make sense for git as globals
[qw(branch branch allow-inherit)],
[qw(branch-group branch allow-inherit)],
- [qw(use-stable-kde branch allow-inherit)],
);
# For modules that are not actually a 'proj' module we skip branch-group
- # and use-stable-kde entirely to allow for global/module branch selection
+ # entirely to allow for global/module branch selection
# options to be selected... kind of complicated, but more DWIMy
if (!$module->scm()->isa('ksb::Updater::KDEProject')) {
@priorityOrderedSources = grep {
- $_->[0] ne 'branch-group' && $_->[0] ne 'use-stable-kde'
+ $_->[0] ne 'branch-group'
} @priorityOrderedSources;
}
@@ -639,13 +637,6 @@ sub _determinePreferredCheckoutSource
return qw(none none);
}
- # One fixup is needed for use-stable-kde, to pull the actual branch name
- # from the right spot. Although if no branch name is set we use master,
- # without trying to search again.
- if ($sourceTypeRef->[0] eq 'use-stable-kde') {
- $checkoutSource = $module->getOption('#branch:stable', 'module') || 'master';
- }
-
# Likewise branch-group requires special handling. checkoutSource is
# currently the branch-group to be resolved.
if ($sourceTypeRef->[0] eq 'branch-group') {
diff --git a/vim/syntax/kdesrc-buildrc.vim b/vim/syntax/kdesrc-buildrc.vim
index e60c4731..f3c76518 100644
--- a/vim/syntax/kdesrc-buildrc.vim
+++ b/vim/syntax/kdesrc-buildrc.vim
@@ -65,7 +65,7 @@ syn keyword ksbrcErrorModuleSetOption contained skipwhite nextgroup=ksbrcStringV
\ use-modules ignore-modules
syn keyword ksbrcBoolOption contained skipwhite nextgroup=ksbrcBoolValue
- \ build-system-only build-when-unchanged ignore-kde-structure
+ \ build-system-only build-when-unchanged
\ include-dependencies install-after-build manual-build manual-update
\ no-src reconfigure recreate-configure refresh-build run-tests
\ use-clean-install compile-commands-export compile-commands-linking
More information about the kde-doc-english
mailing list