Add documentation for ExtraPermissionsProvider on the component admin page

[Ryan J Ollos]

The ExtraPermissionsProvider is documented on t.e.o, but there is no documentation provided with the distribution other than the snippet here: TracPermissions#CreatingNewPrivileges. There, it is stated For more information, please refer to the documentation of the component in the admin panel. However, there is no documentation of the component in the admin panel, so the proposal is to add documentation.

[Ryan J Ollos]

It seems there is documentation for ExtraPermissionsProvider, but while it is visible on the admin panel in 0.12.6dev, it is not visible in 1.0.2dev.

[Ryan J Ollos]

Okay, I see now. TracPermissions#CreatingNewPrivileges has been edited. I propose a simple patch to help users navigate to the documentation:

tracopt/perm/config_perm_provider.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2009 Edgewall Software
+# Copyright (C) 2009-2013 Edgewall Software
 # All rights reserved.
 #
 # This software is licensed as described in the file COPYING, which
@@ -17 +17 @@
 
 
 class ExtraPermissionsProvider(Component):
-    """Extra permission provider."""
+    """Define arbitrary permissions.
+
+    Documentation can be found on the [wiki:TracIni#extra-permissions-section]
+    page after enabling the component."""
 
     implements(IPermissionRequestor)

[Ryan J Ollos]

Committed to 1.0-stable in [12416] and merged to trunk in [12417].

[Ryan J Ollos]

I have one other change to propose in response to a ​question on the mailing list.

For reference, ExtraPermissionsProvider was added in [8631], but I don't see an associated ticket.

While it makes sense to ignore the casing​ of the permissions defined in trac.ini, it is a bit confusing to show the example in lowercase given the convention of having upper-case characters for permission names. Therefore the proposed patch changes the example to use upper-case characters and adds a note about the case-insensitivity of the definitions in trac.ini.

Proposed changes in log:rjollos.git:t11429.

[Ryan J Ollos]

Change from comment:4 committed to 1.0-stable in [12722], merged to trunk in [12723].

[Ryan J Ollos]

Edited ExtraPermissionsProvider@7 and ExtraPermissionsProvider@8 with changes proposed in comment:4.

Minor change in r15359.