Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise SDL-0305 Homogenize TextFieldName #1109

Merged
merged 3 commits into from
Jan 27, 2021
Merged

Conversation

iCollin
Copy link
Contributor

@iCollin iCollin commented Dec 16, 2020

Introduction

This is a revision to an accepted, but not yet implemented proposal. The suggested revision is to remove the TextFieldName navigationText from the HMI_API.xml instead of adding it to the MOBILE_API.xml. As described navigationText and turnText refer to the same text field, and turnText is the only one of the two that is used in SDL Core, so navigationText is redundant and can be removed.

Motivation

It has been noticed that navigationText is not used by sdl_core or either supported HMI as a TextFieldName.

Proposed Solution

The proposed solution is to remove redundant TextFieldName navigationText from the project.

HMI API Changes

Remove navigationText from TextFieldName

  <enum name="TextFieldName">
  ...
-  <element name="navigationText">
-    <description>Navigation text for turnList parameter of UpdateTurnList</description>
-  </element>
  </enum>

Mobile API Changes

Do not add navigationText to TextFieldName

  <enum name="TextFieldName" since="1.0">
  ...
- +       <element name="navigationText" since="X.X">
- +           <description>Navigation text for turnList parameter of UpdateTurnList</description>
- +       </element>
  </enum>

Potential Downsides

The author does not foresee any potential downsides as this TextFieldName is not used.

Impact On Existing Code

Some additional changes would be required to remove navigationText from HMI capabilities.

While `navigationText` is used as a parameter name in sdl_core, it is not used as a text field name
@iCollin iCollin changed the title [SDL 0305] Homogenize TextFieldName Revision: Additionally Remove navigationText Requested Revisions: SDL-0305 Homogenize TextFieldName Dec 16, 2020
@iCollin iCollin changed the title Requested Revisions: SDL-0305 Homogenize TextFieldName Revise SDL-0305 Homogenize TextFieldName Dec 16, 2020
@iCollin
Copy link
Contributor Author

iCollin commented Dec 16, 2020

@jordynmackool @pelsila This revision is ready for review

@jordynmackool jordynmackool merged commit 501d60a into master Jan 27, 2021
@jordynmackool jordynmackool deleted the revision/0305 branch January 27, 2021 21:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants