diff options
author | Eric Eastwood <contact@ericeastwood.com> | 2018-03-28 11:05:14 -0500 |
---|---|---|
committer | Eric Eastwood <contact@ericeastwood.com> | 2018-03-28 11:05:14 -0500 |
commit | d5f0d89f9d48dc14fbc3091547d6ff257a868586 (patch) | |
tree | 727776c2cab01b4b0ab7bae3755ba8bb999209cb /doc/development/ee_features.md | |
parent | a1cde68d208437a470267e28ccff66fe8be88c2e (diff) | |
download | gitlab-ce-d5f0d89f9d48dc14fbc3091547d6ff257a868586.tar.gz |
Remove EE-specific comments from CE44752-remove-ee-specific-comments
Diffstat (limited to 'doc/development/ee_features.md')
-rw-r--r-- | doc/development/ee_features.md | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index fea92e740cb..cc46720dca2 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -33,6 +33,26 @@ rest of the code should be as close to the CE files as possible. [single code base]: https://gitlab.com/gitlab-org/gitlab-ee/issues/2952#note_41016454 +### EE-specific comments + +When complete separation can't be achieved with the `ee/` directory, you can wrap +code in EE specific comments to designate the difference from CE/EE and add +some context for someone resolving a conflict. + +```rb +# EE-specific start +stub_licensed_features(variable_environment_scope: true) +# EE specific end +``` + +```haml +-# EE-specific start += render 'ci/variables/environment_scope', form_field: form_field, variable: variable +-# EE-specific end +``` + +EE-specific comments should not be backported to CE. + ### Detection of EE-only files For each commit (except on `master`), the `ee-files-location-check` CI job tries @@ -405,12 +425,13 @@ to avoid conflicts during CE to EE merge. } } -/* EE-specific styles */ +// EE-specific start .section-body.ee-section-body { .section-title { background: $gl-header-color-cyan; } } +// EE-specific end ``` ## gitlab-svgs |