Options not written to trac.ini when --inherit option used

[Ryan J Ollos]

Tested with the latest trunk r14154. The trac.ini file on the left was created using an empty inherited file --inherit=`pwd`/global.ini. The file on the right was created without specifying --inherit. It seems many options are missing from trac.ini when --inherit is used.

It seems only ConfigSections and options explicitly specified when creating the environment are written. In the case that a ConfigSection is specified in the inherited file it won't be written.

The possible reason for not writing an option when there is an inherited file is to avoid having to delete the option from trac.ini when it is added to the inherited file. It seems inconsistent though to have only ConfigSections in trac.ini.

I'll have to investigate if the behavior changed after #11437.

conf/trac.ini

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 
+[attachment]
+max_size = 262144
+max_zip_size = 2097152
+render_unsafe_content = disabled
+
+[browser]
+color_scale = enabled
+downloadable_paths = /trunk,/branches/*,/tags/*
+hide_properties = svk:merge
+intermediate_color = 
+intermediate_point = 
+newest_color = (255, 136, 136)
+oldest_color = (136, 136, 255)
+oneliner_properties = trac:summary
+render_unsafe_content = disabled
+wiki_properties = trac:description
+
+[changeset]
+max_diff_bytes = 10000000
+max_diff_files = 0
+wiki_format_messages = enabled
+
+[header_logo]
+alt = (please configure the [header_logo] section in trac.ini)
+height = -1
+link = 
+src = site/your_project_logo.png
+width = -1
+
 [inherit]
-file = /home/user/Workspace/test-inherit/global.ini
+htdocs_dir = 
+plugins_dir = 
+templates_dir = 
+
+[logging]
+log_file = trac.log
+log_format = 
+log_level = DEBUG
+log_type = none
 
 [mainnav]
 admin.order = 8.0
@@ -20 +57 @@
 logout.order = 2.0
 prefs.order = 3.0
 
+[milestone]
+default_retarget_to = 
+stats_provider = DefaultTicketGroupStatsProvider
+
+[mimeviewer]
+max_preview_size = 262144
+mime_map = text/x-dylan:dylan,text/x-idl:ice,text/x-ada:ads:adb
+mime_map_patterns = text/plain:README|INSTALL|COPYING.*
+pygments_default_style = trac
+pygments_modes = 
+tab_width = 8
+treat_as_binary = application/octet-stream,application/pdf,application/postscript,application/msword,application/rtf
+
+[notification]
+admit_domains = 
+ambiguous_char_width = single
+batch_subject_template = $prefix Batch modify: $tickets_descr
+email_address_resolvers = SessionEmailResolver
+email_sender = SmtpEmailSender
+ignore_domains = 
+mime_encoding = none
+sendmail_path = sendmail
+smtp_always_bcc = 
+smtp_always_cc = 
+smtp_default_domain = 
+smtp_enabled = disabled
+smtp_from = trac@localhost
+smtp_from_author = disabled
+smtp_from_name = 
+smtp_password = 
+smtp_port = 25
+smtp_replyto = trac@localhost
+smtp_server = localhost
+smtp_subject_prefix = __default__
+smtp_user = 
+ticket_subject_template = $prefix #$ticket.id: $summary
+use_public_cc = disabled
+use_short_addr = disabled
+use_tls = disabled
+
 [notification-subscriber]
 always_notify_cc = CarbonCopySubscriber
 always_notify_previous_updater = TicketPreviousUpdatersSubscriber
 always_notify_updater = TicketUpdaterSubscriber
 
 [project]
+admin = 
+admin_trac_url = .
+descr = My example project
+footer = Visit the Trac open source project at<br /><a href="http://trac.edgewall.org/">http://trac.edgewall.org/</a>
+icon = common/trac.ico
 name = My Project
+url = 
+
+[query]
+default_anonymous_query = status!=closed&cc~=$USER
+default_query = status!=closed&owner=$USER
+items_per_page = 100
+ticketlink_query = ?status=!closed
+
+[report]
+items_per_page = 100
+items_per_page_rss = 0
+
+[revisionlog]
+default_log_limit = 100
+graph_colors = #cc0,#0c0,#0cc,#00c,#c0c,#c00
+
+[roadmap]
+stats_provider = DefaultTicketGroupStatsProvider
+
+[search]
+default_disabled_filters = 
+min_query_length = 3
+
+[sqlite]
+extensions = 
+
+[svn]
+authz_file = 
+authz_module_name = 
+
+[ticket]
+allowed_empty_fields = milestone,version
+default_cc = 
+default_component = 
+default_description = 
+default_keywords = 
+default_milestone = 
+default_owner = < default >
+default_priority = major
+default_resolution = fixed
+default_severity = 
+default_summary = 
+default_type = defect
+default_version = 
+max_comment_size = 262144
+max_description_size = 262144
+max_summary_size = 262144
+preserve_newlines = default
+restrict_owner = disabled
+workflow = ConfigurableTicketWorkflow
 
 [ticket-workflow]
 accept = new,assigned,accepted,reopened -> accepted
@@ -51 +183 @@
 resolve.operations = set_resolution
 resolve.permissions = TICKET_MODIFY
 
+[timeline]
+abbreviated_messages = enabled
+changeset_collapse_events = disabled
+changeset_long_messages = disabled
+changeset_show_files = 0
+default_daysback = 30
+max_daysback = 90
+newticket_formatter = oneliner
+ticket_show_component = disabled
+ticket_show_details = disabled
+
 [trac]
+auth_cookie_lifetime = 0
+auth_cookie_path = 
+auto_preview_timeout = 2.0
+auto_reload = disabled
+backup_dir = db
+base_url = 
+check_auth_ip = disabled
 database = sqlite:db/trac.db
+debug_sql = disabled
+default_charset = utf-8
+default_date_format = 
+default_dateinfo_format = relative
+default_handler = WikiModule
+default_language = 
+default_timezone = 
+genshi_cache_size = 128
+htdocs_location = 
+ignore_auth_case = disabled
+jquery_location = 
+jquery_ui_location = 
+jquery_ui_theme_location = 
+never_obfuscate_mailto = disabled
+permission_policies = ReadonlyWikiPolicy,DefaultPermissionPolicy,LegacyAttachmentPolicy
+permission_store = DefaultPermissionStore
+request_filters = 
+resizable_textareas = enabled
+secure_cookies = disabled
+show_email_addresses = disabled
+show_ip_addresses = disabled
+timeout = 20
+use_base_url_for_redirect = disabled
+use_chunked_encoding = disabled
+use_xsendfile = disabled
+wiki_toolbars = enabled
+xsendfile_header = X-Sendfile
+
+[versioncontrol]
+allowed_repository_dir_prefixes = 
+default_repository_type = svn
+
+[wiki]
+default_edit_area_height = 20
+ignore_missing_pages = disabled
+max_size = 262144
+render_unsafe_content = disabled
+safe_schemes = cvs,file,ftp,git,irc,http,https,news,sftp,smb,ssh,svn,svn+ssh
+split_page_names = disabled

[Ryan J Ollos]

I also noticed that the following documentation may be inaccurate:

initenv [<projectname> <db> [<repostype> <repospath>]]

    Create and initialize a new environment

    If no arguments are given, then the required parameters are requested
    interactively.

    One or more optional arguments --inherit=PATH can be used to specify the
    "[inherit] file" option at environment creation time, so that only the
    options not already specified in one of the global configuration files are
    written to the conf/trac.ini file of the newly created environment.
    Relative paths are resolved relative to the "conf" directory of the new
    environment.

Regarding Relative paths are resolved relative to the "conf" directory of the new environment:

Since the directory cannot already exist when creating an environment, it seems it would not be possible to use a relative path for the --inherit option.

[Ryan J Ollos]

I see that the behavior described in comment:description is documented: tags/trac-1.1.5/trac/env.py@:548-550#L543​.

[Ryan J Ollos]

Replying to Ryan J Ollos:

Since the directory cannot already exist when creating an environment, it seems it would not be possible to use a relative path for the --inherit option.

It does work, it's just a bit confusing.

$ ls inherit.ini
inherit.ini
$ trac-admin env initenv --inherit=../../inherit.ini "My Project" sqlite:db/trac.db

It might be more clear to resolve relative paths to the current directory and then prefix the inherit option with ../.. when writing to trac.ini. It's probably not worth bothering with now.