summaryrefslogtreecommitdiffstats
path: root/HACKING.rst
Commit message (Collapse)AuthorAgeFilesLines
* Clean up and make HACKING.rst DRYerJoe Gordon2013-07-011-290/+16
| | | | | | | Reference the OpenStack hacking guide in HACKING.rst and remove duplicated entries. Add new section for nova specific rules. Change-Id: I704a49a0675acf1870953c76eba4978a1c4490eb
* Merge "Add notes about how doc generation works."Jenkins2013-06-131-0/+21
|\
| * Add notes about how doc generation works.Monty Taylor2013-06-021-0/+21
| | | | | | | | Change-Id: I562c743798aeae5e49bd2f96944c3cacd776a53d
* | Replace openstack-common with oslo in HACKING.rstThomas Bechtold2013-06-071-6/+6
| | | | | | | | Change-Id: I8c6426983ec374e903c64108b990e5d4550e3fcc
* | Improve Python 3.x compatibilityDirk Mueller2013-06-011-0/+19
|/ | | | | | | | | Mechanical translation of the deprecated except x,y: construct with except x as y: The latter works with any Python >= 2.6. Add Hacking check. Change-Id: I845829d97d379c1cd9b3a77e7e5786586f263b64
* docs should indicate proper git commit limitSteven Dake2013-03-041-2/+2
| | | | | | | | | | | The nova gate should recommend 50 characters or less for a git commit but actually enforce 72 characters. This patch changes the hacking.rst docs to indicate the actual limit is 72 characters rather then 50 characters. Change-Id: I47f1f1f1007f5744bf1fef419df7e033803b4a53 Fixes: Bug #1144840
* Fix broken logging imports.Vishvananda Ishaya2013-02-191-1/+0
| | | | | | | | This fixes all of the files incorrectly importing logging directly and removes the workaround in hacking.py that was due to improper from nova.openstack.common.log import logging statements. Change-Id: Icfc25dc148c4a7b5fa7f6a7b609cd6c3d94efee1
* Module import style checking changesAttila Fazekas2013-02-131-0/+3
| | | | | | | | | | | | | | * Implementing the * import detection (it is disabled for now) * New style relative import testing based on syntax rules * Old style relative import testing based on module search * Inspection based solution replaced by PYTHONPATH search in order to avoid module compile and initialization steps (code execution) in a syntax checking phase. This solution is faster and safer, but does not able to recognize modules added dynamically to the module scope. Change-Id: Ifc871f4fdbcd4a9a736170ceb4475f4f2cbe66bc
* Update docs about testing.Monty Taylor2013-02-111-1/+21
| | | | | | | | Add an entry to the HACKING file about testr. While in there, noticed a reference to the now-defunct nova/testing dir. Fixed that, moved the testing README into nova/tests and remove the nova/testing dir. Change-Id: Ibf6fb82658ba73eee9123fa53b340d0b72afb292
* Update HACKING.rst per recent changesZhongyue Luo2013-02-041-3/+10
| | | | | | | | | | | | Added "is not" usage with examples * https://review.openstack.org/#/c/20865/ Fixed "not in" usage description * https://review.openstack.org/#/c/20875/ Fixed some "not X in Y" corner cases. Change-Id: I7534ef73e6fd525fd8f4bee594a4b37524699c08
* Fixes 'not in' operator usageZhongyue Luo2013-01-311-0/+12
| | | | Change-Id: I1e26a8fcb9fa564308e63c11a72aaa55119e4eee
* don't allow crs in the codeSean Dague2013-01-161-0/+1
| | | | | | | | triggered by this slipping into quantum, now that we have more windows developers we should ensure that \r\n doesn't land in the code as a line ending. This check prevents it. Change-Id: I0a82be0e74915d3c3c25203db110d279580c148b
* Changed 'OpenStack, LLC' message to 'OpenStack Foundation'Kurt Taylor2013-01-071-1/+1
| | | | Change-Id: Iffad63690d2d7565c651ff3faec4443d0ed471c3
* Ban db import from nova/virtDan Smith2012-11-121-0/+1
| | | | | | | | | | | | | | This makes hacking.py complain if someone adds something like: from nova import db into any of the files in nova/virt/* (aside from the fake.py file). It also removes the rest of the dangling db imports that are no longer needed. Yay! Change-Id: Iba3d53b87e65e33a55f8e5033b5d1d33b28d12f7
* hacking: Add driver prefix recommendation.Rick Harris2012-08-291-0/+4
| | | | | | | | | Prefixing the commit message's first line with the driver makes it easier for reviewers, at a glance, to find reviews that relate to their area of expertise as well as improving the overall readability of the git history. Change-Id: I376d2cdb5dc344717fb7749a80e33ee88603e68c
* OpenStack capitalization added to HACKING.rstJoe Gordon2012-08-171-0/+9
| | | | | | Along with capitalization fixes to comments in code Change-Id: I72ddc582001f80d954ca5a121903c689f40d08d1
* Add a 50 char git title limit test to hacking.Joe Gordon2012-08-081-1/+2
| | | | | | * add N802 to hacking.py Change-Id: I8262531b4b3f8f3a1a2a37679904cf4864cae7b6
* Add a link from HACKING to wiki GitCommitMessages pageDaniel P. Berrange2012-07-301-0/+6
| | | | | | | | | | | | | | The HACKING file contains a short example of an effective commit message. For reasons for space, it cannot describe the rationale behind this example. It also does not have space to describe how to split up a patch into a series of commits. Add a link from the HACKING file to the wiki http://wiki.openstack.org/GitCommitMessages where further information can be found Change-Id: I34d44485486b623b11743106f09d5ef631d35888
* Expand HACKING with commit message guidelinesBrian Waldon2012-07-021-0/+21
| | | | | | | Add a 'Commit Messages' section to HACKING describing how a commit message should be formed. Change-Id: I29b69022dfbdac09523eaa5cef3fc1a4550a7c5f
* Backslash continuation removal (Nova folsom-2)Zhongyue Luo2012-05-311-0/+2
| | | | | | | | Fixes bug #938588 Backslash continuations removal for scripts in bin/, plugin/, and etc. Change-Id: Idd17048b6e8db6e939946968e011e68da8585b8d
* Improved tools/hacking.pyJoe Gordon2012-04-241-1/+1
| | | | | | | | | | | | | * cleaner output * fix bug 980009 * Fix N201 * N306: alphabetical order imports * N401: docstring start * N402: one line docstring start * N403: multi line docstring end * Until fixed, N40* will be disabled by default Change-Id: I9addafdaa7a1f8fb950e14a5409f661dec6c7b87
* HACKING fixes, sqlalchemy fix.Yuriy Taraday2012-04-091-2/+8
| | | | | | | Add exceptions to hacking.py make sqlalchemy stuff legal and prevent clutter. Change-Id: I44b100b4c0c4dfcec81beea7aba2d8598d5a08d0
* Reordered the alphabet.Andrew Bogott2012-03-231-1/+1
| | | | | | | | | | | | | | | Just putting this out there... I'm pretty sure that import nova.flags comes after from nova.endpoint import cloud Unless I'm totally misunderstanding how this is supposed to work, which is likely. Change-Id: I51096ab25dbca42d73a593872b83b25f2c451210
* Clarify HACKING's shadow built-in guidance.Rick Harris2012-03-211-1/+12
| | | | Change-Id: Icf38d3ec3254e83d2289b7b17966ec44d9757b8c
* Clear created attributes when tearing down testsJohannes Erdfelt2012-03-071-12/+0
| | | | | | | | | | | | | | | | unittest will keep each test case around after completion pinning any objects references by attributes on the test case. This can bloat the memory used during a full test suite run to the point where the test suite will require much more memory than running all of the services does. On systems witout lots of memory, test suite failures will occur as test cases cannot fork to execute programs. Clearing out __dict__ of any attributes that don't start with a _ (since some are needed by unittest itself) reduces memory significantly. This does require the super class tearDown to be called last in some cases however. Change-Id: I0e660b6c2a77c5613c5a523ba0a64c3d7f6dd128
* assertRaises(Exception, ...) considered harmfulJohannes Erdfelt2012-03-041-0/+12
| | | | | | | | | | | | | | | Expecting that Exception is raised can end up passing an a test when an unexpected error occurs. For instance, errors in the unit test itself can be masked: https://review.openstack.org/4848 https://review.openstack.org/4873 https://review.openstack.org/4874 Change a variety of unit tests to expect a more specific exception so we don't run into false positive tests in the future. Change-Id: Ibc0c63b1f6b5574a3ce93d9f02c9d1ff5ac4a8b0
* Update cfg from openstack-commonMark McLoughlin2012-02-071-0/+15
| | | | | | | | | | | | | | Use openstack-common's update.py script to pull in some recent changes: * Add the Mapping interface to cfg.ConfigOpts * Add support to cfg for disabling interspersed args Make use of both of these in nova/flags.py. Add some dire warnings to HACKING about directly modifying the copy of openstack-common code. I'm confident they won't be ignored :-) Change-Id: I7ef75d18922c0bbb8844453b48cad0418034bc11
* Update HACKING.rst.Kevin L. Mitchell2012-01-051-4/+1
| | | | | | | | | Removes the requirement for a trailing blank line in multiline docstrings, just before the closing '"""'. This blank line is not needed anymore, as the editors it was recommended for no longer have the problem that this blank line was working around. Change-Id: I4e532231f1d99e9f5048cbfcc791a4328fb1e8f5
* First steps towards consolidating testing infrastructureDuncan McGreggor2011-12-061-0/+184
This commit begins to implement blueprint consolidate-testing-infrastructure by adding a 'testing' subpackage and moving some modules into it. Change-Id: I04bf860bc386bd2016e7dbc5a6f6ef7379a855bb
generated by cgit (git 2.34.1) at 2024-05-06 15:16:00 +0000