iilyak opened a new pull request #1192: Fix dialyzer warning on 
`couch_key_tree:merge/2`
URL: https://github.com/apache/couchdb/pull/1192
 
 
   ## Overview
   
   The spec of `couch_key_tree:merge/2` doesn't include the `path()`
   type. However we pass `path()` in few places. One of such places is
   `couch_db:prep_and_validate_replicated_updates/5`.
   
   ```
   {NewTree, _} = couch_key_tree:merge(AccTree,
       couch_doc:to_path(NewDoc), RevsLimit),
   NewTree
   ```
   
   The spec for `couch_doc:to_path/1` is defined as:
   ```
   -spec to_path(#doc{}) -> path().
   ```
   
   This PR adds `path()` type to `couch_key_tree:merge/2` spec.
   
   ## Testing recommendations
   
   Run dialyzer tool and make sure there are no complains about 
`couch_key_tree:merge`
   1. Prepare for analysis:
     ```
   make build-plt
     ```
   2. Run analysis 
     ```
   make dialyze apps=couch
     ```
   The dialyzer might fail but it shouldn't fail in analysis of 
`couch_key_tree`, `couch_db` or `test_engine_util`.
   
   ## Checklist
   
   - [ ] Code is written and works correctly;
   - [ ] Changes are covered by tests;
   - [ ] Documentation reflects the changes;
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to