Page MenuHomeWildfire Games

technology naming consistency: storehouse and farmstead researches
Needs ReviewPublic

Authored by Nescio on Sep 18 2017, 1:12 PM.
This revision needs review, but there are no reviewers specified.

Details

Reviewers
None
Summary

For comparison the naming of other technologies, e.g.:

attack_cavalry_melee_01.json
attack_cavalry_melee_01.json

From a single quick glance at the name it's immediately clear what the technology probably does and in what order they're available.

This is currently not the case with gather technologies, e.g.:

gather_mining_serfs.json
gather_mining_servants.json
gather_mining_shaftmining.json
gather_mining_silvermining.json
gather_mining_slaves.json
gather_mining_wedgemallet.json

This patch renames storehouse and farmstead researches to be more consistent and precise, e.g.:

gather_metal_01.json
gather_metal_02.json
gather_metal_03.json
gather_stone_01.json
gather_stone_02.json
gather_stone_03.json
Test Plan

Small patch, little to test

Diff Detail

Repository
rP 0 A.D. Public Repository
Branch
/ps/trunk
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 3257
Build 5627: Vulcan BuildJenkins
Build 5626: arc lint + arc unit

Event Timeline

Nescio created this revision.Sep 18 2017, 1:12 PM
Owners added a subscriber: Restricted Owners Package.Sep 18 2017, 1:12 PM
Vulcan added a subscriber: Vulcan.Sep 18 2017, 2:32 PM

Build is green

Updating workspaces.
Build (release)...
Build (debug)...
Running release tests...
Running cxxtest tests (307 tests)...................................................................................................................................................................................................................................................................................................................OK!
Running debug tests...
Running cxxtest tests (307 tests)...................................................................................................................................................................................................................................................................................................................OK!
Checking XML files...

http://jenkins-master:8080/job/phabricator/2051/ for more details.

Nescio updated this revision to Diff 3772.Sep 25 2017, 10:49 AM
Nescio edited the summary of this revision. (Show Details)

Updated (necessary because of minor file conflict with rP20210; solved)

@Nescio:
Namming in that folder is indeed not always consistent (due to different people having different (or no) policies).
Just to grab your input. (A patch with things to rename, to move, to delete, to add, doesn't really attract people if there isn't an obvious benefit)

There are 2 things in the patch:

  • making it more explicit
  • removing name from the tech and replacing it with a number

I won't discuss the 1st point as I have no opinion about that.
For the 2nd point, what happens if we want to change the order or include other same kind of tech?

Build is green

Updating workspaces.
Build (release)...
Build (debug)...
Running release tests...
Running cxxtest tests (307 tests)...................................................................................................................................................................................................................................................................................................................OK!
Running debug tests...
Running cxxtest tests (307 tests)...................................................................................................................................................................................................................................................................................................................OK!
Checking XML files...

http://jenkins-master:8080/job/phabricator/2068/ for more details.

Admittedly, the benefit of this patch (and of D888) is rather minor. However, the advantage of naming consistency is that it's easier to edit, expand, maintain, and modify. It doesn't limit possibilities, it might be helpful, therefore it's useful to implement, is my reasoning.

As for your last question, if you want to change the order of technologies, the two easiest options are:

  • keep the file names and supersedes tags unchanged and change the description etc.
  • keep the description etc. unchanged and swap the file names and supersedes tags

Basically this is the same you would have to do in the current situation. Renaming files doesn't change anything fundamental.